Flamio Scout

Connect GitHub

Beta

Install the Flamio app on GitHub to see every pull request and deploy on Delivery, and Flamio Scout results on their commits.

Install the Flamio app on the GitHub account or organization that holds your code, and Delivery shows every pull request and deploy of the repositories you pick — checked or not, with its author, the branch it merges into and when it merged. With Show Scout results in GitHub on, each Scout check your pipeline runs, and each staging check, also shows on its commit and pull request in GitHub.

Before you begin

  • You need the Editor, Admin or Owner role.
  • Installing the Flamio app happens on github.com, by someone GitHub lets install apps on that account — on an organization, an owner.
  • Deploys come from GitHub deployments: a GitHub Actions job with an environment, or a host that reports deployments to GitHub, as Vercel and Netlify do.
  • A Scout result reaches a commit for checks your pipeline runs with a CI key — see Check every deployed preview from CI — and for staging checks.

What Flamio reads and writes

  • Reads: the repositories you pick, their pull requests, their deployments and environments, and which pull requests each deploy brought. When you connect, Flamio reads the last 90 days. It also reads .flamio.yml on the default branch, and on a pull request that changes it — see Keep the rules in your repository.
  • Writes: with Show Scout results in GitHub on, a "Flamio Scout" check on each commit a Scout check ran on, and a "Flamio config" check on each commit and pull request that changes .flamio.yml. Flamio never writes to your code.
  • On GitHub you choose which repositories the Flamio app may read: all of them, or only the ones you select.

Connect your account

Open Code hosting

Click Settings at the bottom of the sidebar, then Integrations. The GitHub tile is under Code hosting. Click Connect.

Install the Flamio app

The first time, click Install the Flamio app. In the window that opens, pick the account or organization that holds your repositories, choose the repositories the app may read, and install it.

If a teammate already installed it, click Sign in to GitHub instead. Flamio lists the installations you can see.

Choose the account

Click the account. To use another one, click Install on another account.

Choose repositories

Under Choose repositories, select the repositories this project ships. Only the repositories GitHub lets you see are listed. Enter a name in Search repositories to find one. A repository marked Connected is already on this project. Click Connect — the button names how many you picked.

Add environment addresses

Under Environments, optionally enter the address each environment runs at. A GitHub deployment that has an environment URL sets the address by itself.

Choose whether to show results in GitHub

Leave Show Scout results in GitHub selected to put each check on its commit, and click Done.

Result

The tile shows the Account and each repository with Instant updates, or Reading the last 90 days… while the first read runs. To add more later, click Add repositories; if the dialog asks, click Sign in to GitHub first. Delivery then shows their pull requests and deploys — see Follow your changes on Delivery. To give an environment its address later, see Give an environment its address.

Show Scout results in GitHub

With Show Scout results in GitHub on, each Scout check your pipeline runs, and each staging check, shows on its commit as a check named Flamio Scout: in progress while a pipeline's check runs, then passed or failed — a staging check shows once it ends — with the verdict, the findings by severity and a link to the run in Flamio. When the commit is the head of a pull request, the check shows on the pull request. A check that could not check your site shows as cancelled.

The setting covers every project connected to the account. Turning it off stops new results; results already on commits stay.

Block a merge when a check fails

A failed check blocks a merge only where the branch requires it to pass. In GitHub, add a branch protection rule or a ruleset on the target branch that requires status checks to pass, and pick Flamio Scout. A cancelled check does not pass.

  • The Flamio app is suspended on the tile means an owner suspended it in GitHub. Updates resume once they restore it. Delivery keeps what it has meanwhile.
  • The Flamio app was removed means it was uninstalled from the account. Click Disconnect, then connect GitHub again.
  • No access beside a repository means GitHub no longer lets Flamio read it. Give the app access to it again in GitHub, or unlink it.
  • Unlink from this project (the icon beside a repository) stops this project getting the repository's pull requests and deploys. History already on Delivery stays.
  • Disconnect stops GitHub for every project of your organization. The Flamio app stays installed on the account until an owner removes it in GitHub.

Limitations

  • Flamio connects github.com only — not GitHub Enterprise Server. For it, your pipeline reports its checks and deploys with a CI key — see Report your deploys.
  • Re-running the Flamio Scout check in GitHub does not start a new check. Instead, run your pipeline's job again.