-
Notifications
You must be signed in to change notification settings - Fork 6
Add a RELEASE.md file outlining the release process #94
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| # Release process | ||
|
|
||
| Each release follows semantic versioning. You can read more about this in the | ||
| [Versioning](README.md#versioning) section of the README. | ||
|
|
||
| ## Cadence | ||
|
|
||
| New releases are created based on the amount of meaningful change ready to be | ||
| shipped, and not based on a regular time period. | ||
|
|
||
| Major new releases will be agreed upon by the TSC. | ||
|
|
||
| ## Criteria | ||
|
|
||
| Making a new release requires at least one change that meaningfully impacts | ||
| end users of the library and/or a patched bugfix. Major versions should require | ||
| multiple API breaking changes to be bundled together to minimise maintenance for | ||
| downstream projects. | ||
|
|
||
| Internal changes for the project itself should not constitute a new release. | ||
|
|
||
| All tests must pass before a release is made. This is already enforced by CI on | ||
| the `main` branch, but it should be confirmed before tagging. | ||
|
|
||
| ## Methodology | ||
|
|
||
| When creating a new release, the following procedure should be followed: | ||
|
|
||
| 1. Evaluate the version number for the release based on semantic versioning and | ||
| the included changes. | ||
| 2. Push up a PR adding the version number for Unreleased changes, starting a | ||
| new Unreleased section. | ||
| 3. Once the PR is merged to main, tag the commit using the new version number | ||
| (see [Tagging](#tagging)). | ||
| 4. Create a release on GitHub with notes following the format described in | ||
| [Release notes](#release-notes). | ||
| 5. Send an email to the mailing list: https://lists.aswf.io/g/openqmc-discussion | ||
| 6. Update the Slack channel: https://academysoftwarefdn.slack.com/archives/C09BXDAMFTP | ||
|
|
||
| ## Tagging | ||
|
|
||
| Releases are tagged on the merge commit on `main` using the new version number | ||
| with a `v` prefix, for example `v0.7.2`. Create a tag and push it: | ||
|
|
||
| ```sh | ||
| git tag -a v0.7.2 | ||
| git push origin v0.7.2 | ||
| ``` | ||
|
|
||
| ## Release notes | ||
|
|
||
| The GitHub release notes start with a brief overview sentence summarising the | ||
| release, followed by the relevant sections copied from the version's entry in | ||
| [CHANGELOG.md](CHANGELOG.md). Only include sections that have entries. For | ||
| example: | ||
|
|
||
| ```md | ||
| Minor patch release primarily to resolve issue with unwanted static noise | ||
| patterns across frames. | ||
|
|
||
| ### Changed | ||
|
|
||
| - Improve quality of uniform float distribution in `oqmc::uintToFloat`. | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.