mirror of
https://github.com/falcosecurity/falco.git
synced 2026-03-18 18:58:41 +00:00
78f710c706
Signed-off-by: maxgio92 massimiliano.giovagnoli.1992@gmail.com Co-authored-by: Leo Di Donato <leodidonato@gmail.com>
119 lines
6.7 KiB
Markdown
119 lines
6.7 KiB
Markdown
# 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](https://github.com/falcosecurity/falco/milestones), the milestone with the next version represents what is going to be released.
|
|
|
|
A release happens every two months ([as per community discussion](https://github.com/falcosecurity/community/blob/master/meeting-notes/2020-09-30.md#agenda)), 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](https://github.com/falcosecurity/community). 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
|
|
|
|
Before cutting a release we need to do some homework in the Falco repository. This should take 5 minutes using the GitHub UI.
|
|
|
|
### 1. Release notes
|
|
- Find the previous release date (`YYYY-MM-DD`) by looking at the [Falco releases](https://github.com/falcosecurity/falco/releases)
|
|
- Check the release note block of every PR matching the `is:pr is:merged closed:>YYYY-MM-DD` [filter](https://github.com/falcosecurity/falco/pulls?q=is%3Apr+is%3Amerged+closed%3A%3EYYYY-MM-DD)
|
|
- Ensure the release note block follows the [commit convention](https://github.com/falcosecurity/.github/blob/master/CONTRIBUTING.md#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:>YYYY-MM-DD` [filter](https://github.com/falcosecurity/falco/pulls?q=is%3Apr+is%3Amerged+no%3Amilestone+closed%3A%3EYYYY-MM-DD) ) 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:>YYYY-MM-DD` [filter](https://github.com/falcosecurity/falco/pulls?q=is%3Apr+is%3Amerged+no%3Amilestone+closed%3A%3EYYYY-MM-DD), if any, update those missing
|
|
|
|
### 2. Milestones
|
|
|
|
- Move the [tasks not completed](https://github.com/falcosecurity/falco/pulls?q=is%3Apr+is%3Aopen) to a new minor milestone
|
|
|
|
### 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` updates itself automatically
|
|
- Generate the change log using [rn2md](https://github.com/leodido/rn2md):
|
|
- Execute `rn2md -o falcosecurity -m <version> -r falco`
|
|
- In case `rn2md` emits error try to generate an GitHub OAuth access token and provide it with the `-t` flag
|
|
- Add the latest changes on top the previous `CHANGELOG.md`
|
|
- Submit a PR with the above modifications
|
|
- Await PR approval
|
|
- Close the completed milestone as soon as the PR is merged
|
|
|
|
## Release
|
|
|
|
Now assume `x.y.z` is 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. For reference https://git-scm.com/book/en/v2/Git-Basics-Tagging
|
|
|
|
- Wait for the CI to complete
|
|
|
|
### 2. Update the GitHub release
|
|
|
|
- [Draft a new release](https://github.com/falcosecurity/falco/releases/new)
|
|
- Use `x.y.z` both as tag version and release title
|
|
- Use the following template to fill the release description:
|
|
```
|
|
<!-- Substitute x.y.z with the current release version -->
|
|
|
|
| Packages | Download |
|
|
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| rpm | [](https://download.falco.org/packages/rpm/falco-x.y.z-x86_64.rpm) |
|
|
| deb | [](https://download.falco.org/packages/deb/stable/falco-x.y.z-x86_64.deb) |
|
|
| tgz | [](https://download.falco.org/packages/bin/x86_64/falco-x.y.z-x86_64.tar.gz) |
|
|
|
|
| Images |
|
|
| --------------------------------------------------------------------------- |
|
|
| `docker pull docker.io/falcosecurity/falco:x.y.z` |
|
|
| `docker pull public.ecr.aws/falcosecurity/falco:x.y.z` |
|
|
| `docker pull docker.io/falcosecurity/falco-driver-loader:x.y.z` |
|
|
| `docker pull docker.io/falcosecurity/falco-no-driver:x.y.z` |
|
|
|
|
<changelog>
|
|
|
|
<!-- Substitute <changelog> with the one generated by [rn2md](https://github.com/leodido/rn2md) -->
|
|
|
|
### Statistics
|
|
|
|
| Merged PRs | Number |
|
|
| --------------- | ------ |
|
|
| Not user-facing | x |
|
|
| Release note | x |
|
|
| Total | x |
|
|
|
|
<!-- Calculate stats and fill the above table -->
|
|
|
|
#### Release Manager <github handle>
|
|
|
|
<!-- Substitute Github handle with the release manager's one -->
|
|
```
|
|
|
|
- Finally, publish the release!
|
|
|
|
### 3. Update the meeting notes
|
|
|
|
For each release we archive the meeting notes in git for historical purposes.
|
|
|
|
- The notes from the Falco meetings can be [found here](https://hackmd.io/3qYPnZPUQLGKCzR14va_qg).
|
|
- Note: There may be other notes from working groups that can optionally be added as well as needed.
|
|
- Add the entire content of the document to a new file in [github.com/falcosecurity/community/tree/master/meeting-notes](https://github.com/falcosecurity/community/tree/master/meeting-notes) as a new file labeled `release-x.y.z.md`
|
|
- Open up a pull request with the new change.
|
|
|
|
|
|
## Post-Release tasks
|
|
|
|
Announce the new release to the world!
|
|
|
|
- Publish a blog on [Falco website](https://github.com/falcosecurity/falco-website) ([example](https://github.com/falcosecurity/falco-website/blob/master/content/en/blog/falco-0-28-1.md))
|
|
- 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
|
|
- IFF the on going release introduces a **new minor version**, [archive a snapshot of the Falco website](https://github.com/falcosecurity/falco-website/blob/master/release.md#documentation-versioning)
|