Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 3.78 KB

RELEASE.md

File metadata and controls

81 lines (55 loc) · 3.78 KB
Raw

Falco Release Process

Our release process is mostly automated, but we still need some manual steps to initiate and complete it.

Changes and new features are grouped in milestones, the milestone with the next version represents what is going to be released.

Releases happen on a monthly cadence, towards the 16th of the on-going month, and we need to assign owners for each (usually we pair a new person with an experienced one). Assignees and the due date are proposed during the weekly community call. Note that hotfix releases can happen as soon as it is needed.

Finally, on the proposed due date the assignees for the upcoming release proceed with the processes described below.

Pre-Release Checklist

1. Release notes

  • Let YYYY-MM-DD the day before of the latest release
  • Check the release note block of every PR matching the is:pr is:merged closed:>YYYY-MM-DD filter
    • Ensure the release note block follows the commit convention, otherwise fix its content
    • If the PR has no milestone, assign it to the milestone currently undergoing release
  • Check issues without a milestone (using is:pr is:merged no:milestone closed:>YYYT-MM-DD filter) and add them to the milestone currently undergoing release
  • Double-check that there are no more merged PRs without the target milestone assigned with the is:pr is:merged no:milestone closed:>YYYT-MM-DD filters, if any, fix them

2. Milestones

3. Release PR

  • Double-check if any hard-coded version number is present in the code, it should be not present anywhere:
    • If any, manually correct it then open an issue to automate version number bumping later
    • Versions table in the README.md update itself automatically
  • Generate the change log https://github.com/leodido/rn2md, or https://fs.fntlnz.wtf/falco/milestones-changelog.txt for the lazy people (it updates every 5 minutes)
  • Add the lastest changes on top the previous CHANGELOG.md
  • Submit a PR with the above modifications
  • Await PR approval
  • Close the completed milestone as soon PR is merged

Release

Let x.y.z the new version.

1. Create a tag

  • Once the release PR has got merged, and the CI has done its job on the master, git tag the new release

    git pull
git checkout master
git tag x.y.z
git push origin x.y.z

N.B.: do NOT use an annotated tag

  • Wait for the CI to complete

2. Update the GitHub release

  • Draft a new release

  • Use x.y.z both as tag version and release title

  • Use the following template to fill the release description:

    <!-- Copy the relevant part of the changelog here -->

### Statistics

| Merged PRs        | Number  |
|-------------------|---------|
| Not user-facing   | x       |
| Release note      | x       |
| Total             | x       |

<!-- Calculate stats and fill the above table -->

  • Finally, publish the release!

Post-Release tasks

Announce the new release to the world!

  • Send an announcement to cncf-falco-dev@lists.cncf.io (plain text, please)
  • Let folks in the slack #falco channel know about a new release came out