Connect GitHub to AISOQL

Connecting takes about two minutes and has two parts: install the AISOQL app on GitHub, then link the repositories your team may use. Files can only be pulled from linked repositories.

Before you start

• GitHub integration is part of the Business and Team plans.
• You need to be an owner or admin of your AISOQL organization to connect GitHub and link repositories. Members can pull files once a repository is linked.
• On GitHub you need permission to install apps on the account or organization that owns the repository. If you don't have it, GitHub sends an approval request to the owner (see below).

Step 1: Connect GitHub

1. In AISOQL, open Account & usage → Organization and find the GitHub card.
2. Click Connect GitHub. You're taken to GitHub.
3. Choose where to install the app: your personal account or your company's GitHub organization.
4. Choose Only select repositories and pick the repositories that hold your Salesforce code. (All repositories also works, but giving access only to what you need is safer.)
5. Click Install & Authorize. GitHub sends you back to AISOQL, and the card shows Connected.

AISOQL checks with GitHub that your GitHub account can really see that installation before it's saved, so nobody can attach someone else's repositories.

Step 3: Pull a file into Update Component

1. Open Code Generator → Update existing code.
2. Click Pull a file from GitHub above Current code.
3. Pick the repository and branch. The default branch is listed first.
4. Type part of the file name (for example AccountTrigger) and select the file. Salesforce source under force-app/ is listed first.
5. Click Load into Current code. The code and its file path are filled in for you.
6. Describe the change and click Update Component. Then send it back as a pull request.

AISOQL remembers exactly which version of the file you pulled (branch and commit), so it can check for conflicts with newer changes on that branch before you deploy.

Step 4: Send the change back to GitHub

1. After Update Component finishes, a Send to GitHub panel appears under the result, showing the repository, branch and file.
2. Click Check branch and open pull request.
3. AISOQL compares your version with the branch as it is now:
   • Nobody else changed the file: your change is pushed.
   • Someone changed other lines of the file: both sets of changes are merged and pushed.
   • Someone changed the same lines: nothing is sent. You see the overlapping lines; pull the latest version, re-apply your change and send again.
4. AISOQL pushes to a new branch named aisoql/… and opens a pull request into the branch you pulled from. Review and merge it on GitHub as usual.

Merge check before deploying to Salesforce

If the code you deploy from the Deployment Center was pulled from GitHub, AISOQL first checks that branch again.

• If the file hasn't changed, or changed only in other lines, the deploy goes ahead.
• If it changed in the same lines, or GitHub can't be reached, the deploy is blocked, so you don't overwrite a teammate's newer work in your org.
• An organization admin or owner can deploy anyway by entering a reason. The override is recorded in the audit log.

Code that wasn't pulled from GitHub isn't affected by this check.

What AISOQL can and can't do with your repositories

If your company owns the GitHub organization

If you aren't an owner of the GitHub organization, step 1 sends an installation request to its owners instead of installing. AISOQL shows a message saying the request was sent.

1. Ask a GitHub organization owner to approve the AISOQL app (GitHub notifies them, and they can also find it under the organization's Settings → GitHub Apps).
2. Once it's approved, come back to the Organization page in AISOQL and click Connect GitHub again to finish.

Disconnecting

1. In AISOQL, click Disconnect next to the GitHub account on the Organization page. This removes the connection and all linked repositories from AISOQL.
2. To remove the app from GitHub completely, go to GitHub Settings → Applications → Installed GitHub Apps, choose AISOQL, then Uninstall.

Troubleshooting

Still stuck? Contact us.