Can we ship? - release readiness
One verdict for a project - Ready, Risky or Blocked - with the reason behind it and a one-click fix for each.
In short
"Can we ship?" gives a project one verdict - Ready, Risky or Blocked - from its open bugs, failing monitors and checks, verifications and test coverage. Each reason comes with a one-click fix. You decide when a reason makes a release risky or blocked.
Before you start
- Who: anyone who can open the project reads the verdict. Changing thresholds needs Edit.
- Plan: every plan. Verifications count only on plans with verification.
- First: connect a board to the project if you want its bugs counted.
Steps
- Open a project and choose "Ship" - it opens on "Release". The verdict is on top.
- Read the verdict and the reasons behind it, worst first.
- Press the fix of the first reason, such as "Open the bugs" or "Add a test". It is the one main button; the other reasons' fixes are plain buttons.
Result: you know whether the release is ready, and what to fix first.
Change when it is risky or blocked
- Press "Thresholds".
- For each reason, set from how many it makes the release Risky and from how many it Blocks it. Leave a box empty and the reason never reaches that level.
- Press "Save thresholds". "Use the defaults" puts every reason back.
Good to know
- Thresholds belong to the project; people who can change the project can change them, everyone else sees them.
- To keep the verdict of a release as it was, record the release: /help/api-testing/release-records.
- "Record a release" is a button under the verdict, and the release records follow below on the same screen. The old addresses /api-tester/ship and /api-tester/releases both open this place.
If something goes wrong
- A tip says bugs do not count: no board is connected to the project. Connect one - see /help/boards/connections-and-hiring-boards.
- The page shows first steps instead of a verdict: nothing is tested yet.
- "Risky has to start at or below Blocked.": lower the Risky number or raise the Blocked one.
- "Each reason takes one threshold." and "Only people who can change this project can change when it is ready to ship."
Related
- /help/api-testing/release-records
- /help/api-testing/monitors-and-alerts
- /help/api-testing/verification-workflows