Follow your changes on Delivery
BetaOne board of your pull requests, deploys and releases, with what each Scout check found on them.
Delivery shows your changes on their way to production: each pull request with the Scout checks run on it, each deploy on its environment, and each release your visitors reach. Click any of them to see what its check found. Rules sets what Flamio checks at each step and when a pull request may not merge — see How Flamio runs your delivery.
Before you begin
- Connect GitHub or Bitbucket to see every pull request and deploy of your repositories — see Connect GitHub and Connect Bitbucket. Without one, Delivery shows what your pipeline reports.
- Your pipeline checks previews with a CI key — see Check every deployed preview from CI. Each check of a pull request appears on Delivery.
- To see staging and production, the pipeline reports its deploys too — see Report your deploys.
- Releases come from the Flamio SDK on your site: a release is a new version the SDK reports — see Pass your release version to the SDK.
- Until then, the page reads Connect GitHub or Bitbucket to see pull requests, deploys and releases with Flamio's checks with Connect GitHub, Connect Bitbucket and Connect CI.
Read the board
Open Delivery
Click Delivery in the sidebar and pick the period: 7d, 30d or 90d.
See what is on each environment
The cards on top are the environments your deploys go to, read from GitHub or Bitbucket, or reported by your pipeline. Each one shows what is on it now, whatever the period, and the state of its newest check, such as Passed or Found 1.
A staging card says whether it can go to production:
| Label | Meaning |
|---|---|
| Ready | Its deploy and every pull request on it that production does not have yet passed their newest check. |
| Blocked | A check found a task broken. |
| Checking | A check is still running. |
| Couldn't check | A check could not decide. |
| Not checked | Something on it has no check, only one of an older commit, or more pull requests wait than the card lists. |
| Not deployed | Nothing was deployed there yet. |
Under it, the card counts the pull requests not in production. To have every staging deploy checked, see Check staging after every deploy.
Follow a change
Below, each pull request is a row with its checks. A check of a commit older than the newest is drawn small and faded. Deploys sit on their environment's line. Each production environment has its own line, and a release sits on the line of the production environment it was deployed to.
Fill in what is missing
When a source sent nothing in the period, a notice above the board names it: No deploys reported in this period., No pull requests reported in this period. or No releases in this period. Its link shows how to set that source up. Bitbucket access was removed means Flamio stopped reading Bitbucket: the board keeps what it has until someone clicks Reconnect. The Flamio app is suspended or The Flamio app was removed means the same for GitHub — see Suspended, unlink or disconnect.
Narrow it down
Click Needs attention to keep only what the newest check found something in or could not check. Or type a number or title in Search pull requests.
Open the details
Click a check, a deploy, a release or an environment card. The panel lists What was checked, Checks and Deploys. A release adds Issues on real visits — what On-Live saw New in this release, Fixed in this release or Seen again after its fix — and Pull requests in this release. A staging card adds Not in production: each pull request on it that production does not have yet, with its newest check. Open pull request and Open site leave for the change itself. To give an environment its site address, see Give an environment its address.
Report your deploys
Name the environment of a check
The Flamio Scout GitHub Action sends the environment of the deployment it checks, so the check appears on that environment. When you call the API yourself, add environment to the change of the check:
"change": {
"sha": "4f2a9c1",
"branch": "feature/KAN-33-signin",
"environment": { "name": "Preview" }
}Report a deploy
POST https://api.flamio.org/api/deployments with the same CI key records a deploy:
curl -sS https://api.flamio.org/api/deployments \
-H "Authorization: Bearer $FLAMIO_CI_KEY" \
-H "Content-Type: application/json" \
-d '{
"environment": { "name": "Production" },
"sha": "6f4a2d8",
"ref": "main",
"url": "https://shop.example.com",
"version": "2.4.2",
"repo": "acme/storefront",
"pullRequests": [216, 219]
}'| Field | What it does |
|---|---|
environment | Required. name as your host writes it; kind (preview, staging or production) when the name does not say. A name starting with "prod" is production, a name with "preview" is a preview, anything else is staging. |
sha | Required. The deployed commit. |
ref | The branch or tag deployed. |
url | The deployed address. |
version | The version the site carries — the same value you pass to the Flamio SDK as version. The release itself comes from the SDK; a production deploy with the same version sits on that release. |
repo | owner/name. Required with pullRequests. |
pullRequests | The pull request numbers this deploy brought since the previous deploy to the environment. |
status | success (default), failure, in_progress or inactive. |
deployedAt | When it deployed, ISO 8601. Default: when Flamio receives the report. |
deployId | Your own id of the deploy. A second report with the same id updates the deploy instead of adding one. |
The answer, wrapped in response, carries the deploymentId and the environmentId. The flamio CLI does not report deploys; call the API from your pipeline's deploy step.
Result
Each pull request and deploy your pipeline reports, and each release the Flamio SDK reports, is on Delivery, with the state of its newest check and, for a release, the issues visitors met on it.
Limitations
- Only GitHub and Bitbucket connect as code hosts. For GitLab or any other host, Delivery knows a pull request only from what your pipeline reports: the checks run on it and the deploys that name it. It does not show when such a pull request merged, its author, or pull requests no check ran on.
- Rules block a merge, not a release: a check of a live release reports what it found, and nothing stops the deploy — see How Flamio runs your delivery.