GitHub

Connect GitHub to Scoutflo to bring deployment events, commit history, and PR activity

When you integrate GitHub with Scoutflo, Scoutflo generates a user access token that provides secure, user‑specific access to Scoutflo’s features within GitHub.

This token mirrors the permissions granted to your GitHub user within the organization, enabling Scoutflo to perform actions on your behalf based on your access level.

---

✅ Pre requisites

Before setting up the GitHub App integration, ensure you have:

• A GitHub account with access to the repositories you want Scoutflo to monitor

• Organization or repository permissions to install GitHub Apps

• Access to Scoutflo’s Integrations tab in the platform UI

• If you want Scoutflo to trigger workflows or comment on PRs:

  • Appropriate permissions in your GitHub org/repo

  • For org‑level installs, organization owner approval may be required

If you don’t have these permissions, coordinate with your Platform / SRE team before proceeding.

---

🧩 Setup Guide

To connect GitHub to Scoutflo, you’ll:

1. Install the Scoutflo GitHub App

2. Configure repository access

3. Authorize and validate the connection

4. (Optional) Configure webhooks and permissions

---

Step 1 – Install the Scoutflo GitHub App

1. In the Scoutflo platform UI, navigate to Integrations → GitHub.

2. Click Connect GitHub or Install GitHub App.

3. You will be redirected to GitHub’s App installation page.

4. Select the GitHub organization or personal account where you want to install the app.

5. Choose repositories to grant access to:

   • All repositories (if you want broad coverage)

   • Only select repositories (recommended for initial setup)

6. Click Install to complete the installation.

GitHub will now redirect you back to Scoutflo with the integration authorized.

---

Step 2 – Configure repository access

After installation, Scoutflo needs to know which repositories to monitor for:

• Deployment events (when new code ships)

• Commit history (what changed before incidents)

• PR activity (code reviews, merge events)

In Scoutflo’s Integrations → GitHub page:

1. Review the installed repositories list.

2. Enable monitoring for the repositories you want Scoutflo to watch.

3. Optionally, configure event types to track:

   • Push events (commits)

   • Deployment events (releases, deploys)

   • Pull request events (PRs opened, merged, closed)

Save the configuration. Scoutflo will begin fetching recent events from these repositories.

---

Step 3 – Authorize and validate the connection

Once the app is installed and repositories are selected:

1. In Scoutflo’s Integrations → GitHub section:

   • Check that the integration status shows Connected.

   • Use the Test connection button to validate:

     • App installation is active

     • Selected repositories are accessible

     • Recent events can be fetched

2. Confirm in GitHub:

   • Go to Settings → Applications → Installed GitHub Apps.

   • Find Scoutflo and verify:

     • Installation is active

     • Correct repositories are selected

     • No permission warnings

3. Test event flow:

   • Make a small change (push a commit, open a PR) in a monitored repo.

   • Confirm that Scoutflo picks up the event within a few minutes.

The integration is working when Scoutflo can list your repositories and show recent events (commits, deploys, PRs) in the GitHub integration dashboard.

---

⚠️ Most common failure points

• App installation blocked: Check that your GitHub account has permission to install apps in the target org/repo. Organization owners may need to approve.

• No repositories visible: Verify that the app was installed with access to the expected repositories. Reinstall if needed, selecting the correct repos.

• Permission errors on events: Confirm the GitHub user who installed the app has read access to the repositories Scoutflo is trying to monitor.

• Webhook delivery failures: Check that the webhook URL and secret are entered correctly in GitHub. Test with GitHub’s “Redeliver” feature.