Document releases (#1903)

Summary: This adds more detail about our release process and cadence. This is useful information for users and contributors to know. Relevant Issues: N/A Type of change: /kind docs Test Plan: N/A, this is a doc. Signed-off-by: Michelle Nguyen <[email protected]>
pixie-io · May 14, 2024 · 71cb99a · 71cb99a
1 parent 8b342d7
commit 71cb99a
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -147,3 +147,9 @@ gpg-connect-agent reloadagent /bye
 ```
 
 Here we tell `gpg` to use `pinentry-tty` when prompting for a passphrase, and export the current TTY to tell `gpg` which TTY to prompt on.
+
+### Releases
+
+Pixie has several releasable components. The main ones are: `control plane`, `vizier`, `operator`, Go/Python APIs, and the `cli`. All artifacts in Pixie are released using semantic versioning.
+
+Pixie has a weekly release process for each component, unless there have been no updates. When a component is ready to be released, a release candidate is made by creating a branch off of main. The release candidate branch is pushed to Github, triggering a Github Actions job to build any necessary images and artifacts. Once the build is complete, testing begins. If testing succeeds, a new branch is made for the release to trigger a Github Actions build for the official release. All releases, changelogs, and release notes are published to the [releases page](https://github.com/pixie-io/pixie/releases).