Skip to content

Commit

Permalink
new(docs): added release file.
Browse files Browse the repository at this point in the history
Signed-off-by: Federico Di Pierro <[email protected]>
  • Loading branch information
FedeDP authored and poiana committed Jan 8, 2025
1 parent fdf14c7 commit 4c2ebb4
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ include(FetchContent)
FetchContent_Declare(
plugin-sdk-cpp
GIT_REPOSITORY https://github.com/falcosecurity/plugin-sdk-cpp.git
GIT_TAG 703bd9caab50b139428cea1aaff9974ebee5742e # desired git tag here
GIT_TAG main # or desired git tag here
)
FetchContent_MakeAvailable(plugin-sdk-cpp)
Expand Down
12 changes: 12 additions & 0 deletions release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Release Process

Our release process is fully automated using [Github actions](.github/workflows/release.yaml).

When we release we do the following process:

1. We decide together (usually in the #falco channel in [slack](https://kubernetes.slack.com/messages/falco)) what's the next version to tag
2. Make sure that Makefile `FALCOSECURITY_LIBS_REVISION` points to an actual libs tag, since the release workflow will use the value as a badge
3. A person with repository rights creates the Github Release with empty release notes
4. The automated release workflow will start and generate the release notes

> __NOTE:__ Since the release workflow uses [rn2md](https://github.com/leodido/rn2md) tool to generate release notes, make sure to always set correct `release-note` info in the PR body!

0 comments on commit 4c2ebb4

Please sign in to comment.