From ccb7c19b319b704147f97eda8595d5e0925e576b Mon Sep 17 00:00:00 2001 From: Leo Di Donato Date: Fri, 9 Apr 2021 12:57:58 +0200 Subject: [PATCH] chore: RELEASE.md refinements While prepping Falco 0.28.0 I noticed the correct date (YYYY-MM-DD) to provide to GitHub filters is not the day before the previous release. Instead, it's the day the latest release happened. Also added clearer instructions on how to generate the CHANGELOG. Signed-off-by: Leonardo Di Donato --- RELEASE.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 65515b5c..499db11c 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -13,7 +13,7 @@ Finally, on the proposed due date the assignees for the upcoming release proceed 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 LAST release (-1) and use `YYYY-MM-DD` as the day before of the [latest release](https://github.com/falcosecurity/falco/releases) +- 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/falco/blob/master/CONTRIBUTING.md#commit-convention), otherwise fix its content - If the PR has no milestone, assign it to the milestone currently undergoing release @@ -29,8 +29,9 @@ Before cutting a release we need to do some homework in the Falco repository. Th - 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 https://github.com/leodido/rn2md: - - If you review timeout errors with `rn2md` try to generate an GitHub Oauth access token and use `-t` +- Generate the change log using [rn2md](https://github.com/leodido/rn2md): + - Execute `rn2md -o falcosecurity -m -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