Upcoming Changes: April 2025

[saschjmil]

• Welcome!
• Removing the Staging Branch
• New Behavior for the Main Branch
• New Release Naming Convention and Convenience Tags
• New Pull Request Expectations

Welcome!

Welcome to the Discussions page. We will use this space to post announcements about upcoming changes. We have four announcements to make today.

Removing the Staging Branch

We are removing the staging branch in May 2025. All Pull Requests will target the main branch moving forward.

New Behavior for the Main Branch

To consume a stable release from the main branch, you will need to reference the release tag corresponding to the release you would like to use. We create release tags for each new release and we have added a few more for quality of life.

New Release Naming Convention and Convenience Tags

We are updating our release naming convention. In addition, we are adding convenience tags that map to the latest release, latest minor release, and latest patch release.

For example, if we release v5.2.3, the tags will map as follows:

v5.2.3 → v5.2.3
v5.2 → v5.2.3
v5 → v5.2.3
latest → v5.2.3

If you wish to keep the same behavior as the old main branch, we recommend pinning to the latest release tag. The latest tag will always point to the most recent release.

New Pull Request Expectations

We have a few more expectations when opening a Pull Request. Pull Requests that do not meet these expectations will not be approved. Please refer to our CONTRIBUTING.md for more information.

Developer Certificate of Origin Sign-Off

We expect users to sign off on their commits. For more information, please refer to https://probot.github.io/apps/dco/

Automated Tests

Contributors are expected to include some form of automated testing with their changes. We have developed a Golang testing framework for unit tests and are in the process of developing integration tests. Please refer to our Testing Philosophy documentation for more information about how we structure tests.

Conventional Commits

All Pull Request titles should follow the Conventional Commit standard. Pull Requests without a Conventional Commit prefix will not be merged. For more information, please refer to https://www.conventionalcommits.org/en/v1.0.0/

If you have any questions, please reach out!