Record a release and share its proof

Freeze what was true when you released - the verdict, the suites, the API changes and every decision - and share it as proof with a link that ends.

In short

A release record answers "how do you know it works?" with one link. It freezes the Can we ship? verdict with its reasons for one project and environment. It also freezes the API changes since the last record, the suites run, the verification decisions and the open bugs by severity. Share it as a proof page with a link that ends.

Before you start

• Who: recording needs Run on the project. Sharing and revoking links need Manage. Voiding a record needs Edit.
• Plan: every plan.
• First: open the project's Release screen. An environment takes ten records made by hand a day.

Steps

1. Open the project and choose "Ship" › "Release". The records are below the verdict.
2. Press "Record a release", choose the "Environment" and, if you like, a "Name" such as the version you released.
3. Press "Record". The record is frozen the moment it is made.

1. Open a record and press "Share".
2. Choose "Ends after", from 1 to 365 days, and press "Make the link".
3. Copy the link now - it is shown this once.

Result: anyone with the link sees the proof page. It shows the verdict first, the checks and reasons under it, roles with counts and the fingerprint. It never shows a name, and nothing opens the app. "Print" and "Export as Markdown" are on the page.

Good to know

• A fingerprint shows the document was not changed afterwards. Nothing ever edits a record; a newer one never changes an older one.
• It keeps counts, not titles: no card or bug title, and no text anyone typed about a decision. Inside the workspace the record shows who decided; the proof page shows roles, never names.
• A record says "Incomplete" when its verdict leaves something out - for example a connected board its maker could not open.
• A pipeline that reports its deploys gets a record after each deploy once its suites have finished; "Deploys not recorded yet" lists the ones waiting, with "Record".
• Recording needs Run on the project. An environment takes ten records by hand a day.
• "Links" lists every link with "Revoke". A record holds ten live links at a time, and only people who manage the project share or revoke them.
• Above the list, the project's delivery figures for this month are the same figures Analytics shows.

A link outlives nothing A proof link stops answering in four cases. It ends or is revoked. The project is deleted. The organization is frozen, archived or deleted. Or the record no longer matches its fingerprint.

Void a record made by mistake

"Void", for people who can change the project, marks a record withdrawn for good with one reason: recorded by mistake, for the wrong environment, not released, or another reason. The record itself stays as it was. Its proof page says it was voided - never by whom - and the next record counts its changes from the last record that stands.

If something goes wrong

• A proof link shows "This page was not found": it ended, was revoked, or the project or organization is gone or frozen.
• You cannot record: you need Run on the project, or the environment already has ten records by hand today.

Related

• /help/api-testing/can-we-ship
• /help/api-testing/tests-after-a-deploy
• /help/api-testing/api-changes