- 02 Nov 2022
- 3 Minutes to read
Airtable Sync integration: GitHub Issues
- Updated on 02 Nov 2022
- 3 Minutes to read
Airtable Sync integration allows you to bring information from external tools into a single, centralized table within Airtable. This article covers the process of syncing issues connected to a GitHub repository, based on a customized filter set up in Airtable, to an Airtable base. It's worth noting that this sync integration only works with GitHub Enterprise Cloud or GitHub.com. This sync does not work with GitHub Enterprise Server.
If you haven’t set up a sync before, we recommend first reading the Sync - Basic setup article to become familiarized with how Airtable Sync works.
Add a new synced table
Start by clicking the + symbol next to your list of tables. Then, under “Sync data from”, select the “More...” option. From there, you should see the "GitHub Issues" option.
Select a GitHub account
Select an existing GitHub account (if you’ve already connected to GitHub), or link to a new GitHub account if this is the first time you've set this sync up.
Connecting a new account will take you to the authentication window. For more info on authentication and authorization jump to the section below.
After you have connected your account successfully, you will need to connect to a repository or "Repo."
If this is the first time you are syncing with GitHub, then you will need to install the Airtable GitHub app which you can click to within the sync setup window or by clicking here. This is a requirement on GitHub's end that is needed to allow this sync to work. The installation screen will look like this:
Installing this app allows us to read metadata and read and/or write to issues. More information about this is in the Authentication and authorization section below.
After installing the app successfully, you will see all of the repositories that you have set up in GitHub. Choose the one you would like to sync to Airtable.
Next, you can choose filters to sync with a subset of issues. Currently, there are 7 static fields the GitHub allows users to filter by:
|2. State||5. Mentioned||7. Created after|
We pull these same filters over to the Airtable sync feature so that you can choose whether or not to employ any of them.
Each filtering field will have different options for you to choose from. Whether you choose to filter by all 7 fields or none, click the "Next" button to move on to the next step in the setup process.
Select fields to sync
After clicking next, you’ll be presented with two sync options; you can sync:
- All fields from the GitHub issue, including any fields added by GitHub in the future.
- Specific fields from the GitHub issue.
If you choose to sync specific fields you’ll be shown a menu where you can toggle each individual field that you want to sync from the GitHub Issues source.
Currently, GitHub organizes its issues information into 15 fields:
6. Created At
2. Issue Number
7. Updated At
8. Closed At
13. Comment Count
9. Created By
14. Issue Link
Click the "Next" button after you have chosen how you want the fields to be synced to Airtable.
Create synced table
In the last step before creating your synced table, there are “Settings” options that allow you choose how often you want to sync, and how to handle issues deleted or hidden in GitHub.
- The frequency of syncing. Right now, the options are manual syncing and automatic syncing which happens around every 5 minutes.
- Whether or not deleted issues in GitHub should be removed from the Airtable table. By default, deleted issues will be removed.
Once you’ve selected your desired settings, click the “Create table” button.
Security and OAuth scopes
Authentication and authorization
The authentication window will lead to an authorization window. Authorizing allows us to verify your GitHub identity, know which resources you can access, and act on your behalf.
Airtable only supports a single GitHub external account type, so the scopes listed below are used for the Airtable Sync integration as well as the GitHub automation actions. That is why Airtable requests write access even when setting up a sync, even though we only use the read request portion for the sync.
Airtable will only have access to the issues that the user who connected the GitHub account has access to. Furthermore, it will only have access to issues in repositories that the Airtable Connector GitHub App is installed in. If the user who connected the GitHub account leaves the company and their GitHub account gets deactivated, the sync and automation actions will stop working.
For more information on GitHub scopes, check out GitHub's documentation here.