Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Public feature / patch tracking system, automated Release Notes generation from PRs #95

Closed
t-lo opened this issue Apr 27, 2020 · 1 comment
Labels
kind/debt Technological debt. kind/roadmap A Roadmap item.

Comments

@t-lo
Copy link
Member

t-lo commented Apr 27, 2020

Issue

  • Features and patches are not tracked across channels / releases
  • Release notes are assembled manually, with some guidance from scripts

Impact

  • Patch / feature progression is intransparent / not easily accessible for Flatcar community
  • Assembling release notes - for larger releases in particular, e.g. major Stable releases - take significant manual effort.
    Manual assembly of release notes is error prone and often requires additional engineering time on top of the write-up, to cross-check release notes contents.
  • Security information like CVEs need even more time since CVE contect needs to be manually looked up for every CVE fixed in a release.

Ideal future state

  • Feature / patch progression from Alpha -> Beta -> Stable (i.e. the respective PRs) is visually accessible, e.g. via a project board
    • Automation (GH actions) is in place to update the board on each release
  • PRs follow a strict format and either include optional release notes text (opt-in) or even enforce structure with default release notes text (with exceptions - “opt-out”).
  • Tooling and automation exists to fully auto-generate release notes and CVE information, given two commits (branch tips, tags) as input
@t-lo t-lo added the kind/roadmap A Roadmap item. label Apr 27, 2020
@t-lo t-lo changed the title Public feature / patch tracking system Public feature / patch tracking system, automated Release Notes generation from PRs Jul 28, 2021
@t-lo t-lo added the kind/debt Technological debt. label Jul 28, 2021
@pothos
Copy link
Member

pothos commented Jan 28, 2022

I think we are good for now and will close this:

  • For change log generation we have show-changes in https://github.com/flatcar-linux/flatcar-build-scripts (used for the release note draft) that uses the info of the coreos-overlay/portage-stable/scripts release note entries the PR template mandates
  • The list of CVEs that impact a build is not generated (work ongoing in this area) but one can check whether a CVE is marked as fixed in the changelog folder
  • For PRs that we backport we state the branches we backport to in the PR and we have is-pr-in-branches in https://github.com/flatcar-linux/flatcar-build-scripts as a helper to check if that was really done

@pothos pothos closed this as completed Jan 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/debt Technological debt. kind/roadmap A Roadmap item.
Projects
None yet
Development

No branches or pull requests

2 participants