Setting up an automation to create or update a GitHub issue
Step 1: Create a new automation
To start creating an automation, from the open base of your choice click on Automations in the upper left corner of your screen to open the automation configuration window. Click the + Create automation option to begin the setup process. If you would like, you can rename the automation right away to make it easier to understand what it does.
Once you have connected an account, you’ll need to select the Repository where your automation will either create or update the issue in GitHub.
From here the steps will differ depending on the action you are configuring:
Create a new issue
Under “Title” add either a static title (not recommended) or click the + button to add in a dynamic value from an earlier automation step so that the title will be different for each issue created.
Next, under “Body” add in helpful information that will give context to the issue being created. You can use a mix of static and dynamic values here.
Finally, optionally add static or dynamic Milestones, Labels, and/or Assignees.
Update an issue
You’ll need to input an “Issue number” so that Airtable can update the appropriate issue in GitHub. In most scenarios, you’ll want to store the issue number in Airtable and then be able to dynamically reference that value in the automation so that it can update different issues over time.
Next, under the “Update fields” section click the + Choose field option. You can choose to add and configure one, many, or all of the options (Title, Body, Milestone, Labels, State, or Assignee). Keep in mind that adding a field and leaving it blank in the configuration will clear out any data currently held in that field in GitHub.
Once you’ve configured the automation action consider adding other following Airtable actions. For instance, you could use theCreate record action to create and store a matching issue in Airtable in case you want to update the issue at a later point in time.
Test the automation action step. This is a good point to check your GitHub repository to see if everything is populating as intended. The process can be trial and error depending upon your setup. Once the action step has been tested successfully, you will see some information appear. Particularly, you'll see a link to the exact GitHub issue that was created at the bottom of the test.
Step 5: Test and turn on the automation
Again, be sure to test all of the steps in the automation that you are building. Once every part of the automation has tested successfully, you’ll likely be ready to turn the automation on. Find the red colored “OFF” toggle and click it so the automation now appears as “ON” in green.
Security and OAuth scopes
Authentication and authorization
If this is your first time connecting Airtable to your GitHub account, then you will need to authenticate your account and authorize Airtable's usage. You will also need to install the Airtable GitHub app which you can click to download 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 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 external source sync as well as the GitHub automation actions.
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.