Skip to content
RecipesDoc

Write Release Notes for 2.6.0 from Fixed Bugs, Open Bugs and Test Runs

Certyn drafts the release's notes from its evidence, with each line linked to an issue or a run, and saves them on the release.

For release managers who want notes that match what was really fixed and tested.

Your setup

  • Release 2.6.0 has runs and issues in Certyn.
  • Your team closes fixed bugs in Certyn as fixed, with the version (Fixed in).
  • You want notes for the team or for customers, built on evidence.

Say this to Certyn

Write the release notes for 2.6.0 from what we know: bugs fixed in it, known open bugs, and what was tested. Save them on the release.

What Certyn does

  1. Gets the release summary (app.release.get): its runs with results, the issues found in it, and open issues from earlier releases.
  2. Lists the bugs fixed in 2.6.0: issues closed as fixed with version 2.6.0 (app.query on issues, fixed_in_version).
  3. Lists known open bugs: open issues found in 2.6.0, and open issues from earlier releases, with severity.
  4. Lists what was tested: suites and runs on 2.6.0 with results, per environment, and the areas with no run.
  5. Writes the notes in three parts (Fixed, Known issues, Tested) with issue numbers and shows them to you. After you agree, it saves them on the release (app.release.update with body).

What you get

  • Notes where each line links to an issue or a run.
  • The notes on the release page, under "What is in it".
  • A "not tested" list, so nobody reads the notes as full coverage.

Limits

  • "Fixed" lists only issues closed in Certyn as fixed with version 2.6.0. A bug closed only in Jira, or closed without a version, is missing. Ask Certyn to close the fixed ones with the version first, or paste the list.
  • Saving replaces the release's notes. To keep your text, ask Certyn to add to it.
  • The notes come from Certyn's evidence, not from your commits. A feature with no run or issue is not in them unless you name it.
  • Edit customer-facing notes before you publish them: open issue titles can name internal pages or data.