Skip to content

Latest commit

 

History

History
63 lines (49 loc) · 2.69 KB

RELEASE_PROCESS.md

File metadata and controls

63 lines (49 loc) · 2.69 KB
Raw

Release Management

Release manager(s) of stable releases are responsible for approving and merging backports, tagging stable releases, and sending announcements about them.

Release Process

This section describes the release processes for tracking, preparing, and creating new L3AF releases. This includes information around the release cycles and guides for developers responsible for preparing upcoming stable releases.

Active Development

Active development is happening on the main branch and the target is to release a new version approximately every 6 months.

Release Tracking

Feature work for upcoming releases is tracked through GitHub Projects.

Steps to Create a New Release

  1. Bump the version number (Semantic Versioning 2.0) for the following files:
  1. Create a new pull request for the version number changes
  2. Once the build artifacts complete and all checks pass download the build artifacts, which can be found via the Actions tab on github
  3. Copy the binary into a VM and manually test base functionality (run binary, test API, eBPF programs, etc...). TODO: Add to CI/CD
  4. Add a tag to the commit with the version number changes (e.g., "git tag v1.0.0", "git push --tags")
  5. Navigate to your repository under the l3af-project and find where it says "Releases". Click the "Create a new release" hyperlink
  6. Click the "Choose a tag" dropdown and select the tag created in the previous step
  7. Enter a "Release title" and click on "Generate release notes" button to pull in all the PR changes since the last tagged release
  8. Attach binaries / artifacts to the release by clicking on the "Attach binaries..." text. These are the same artifacts downloaded above
  9. After binaries are uploaded, click the "Publish release" button to post the release

Stable Releases

Stable releases of L3AF include:

  • Maintenance window (any version released in the last 6 to 12 months).
  • Stability fixes backported from the main branch (anything that can result in a crash).
  • Bug fixes deemed worthwhile by the maintainers.

Backports

The process of backporting can consist of the following steps:

  • Changes nominated by the change author and/or members of the L3AF community are evaluated for backporting on a case-by-case basis
  • These changes require approval from both the release manager of the stable release and from the relevant code owners.
  • Once approved, these fixes can be backported from the main branch to an existing or previous stable branch by the branch's release manager.