-
Notifications
You must be signed in to change notification settings - Fork 39
add RELEASE.md document #143
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 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
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,50 @@ | ||
# Releasing | ||
|
||
## Release schedule | ||
|
||
Releases of this library are performed on a when-needed basis. | ||
|
||
Generally one of the maintainers listed in MAINTAINERS.md will perform a release. | ||
|
||
If you would like to request a release since a change or fix has been waiting for a release for some time, | ||
you may open up an issue on github, requesting a release. | ||
|
||
## Versioning | ||
|
||
As usual with Swift packages, we use [Semantic Versioning](https://semver.org/). | ||
|
||
## Make a release | ||
|
||
Development and releases are made from the `main` branch directly, therefore the branch should remain in releasable state at any time. | ||
|
||
Making a release is simple and boils down to making a git tag and pushing it to the upstream repository. | ||
ktoso marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
Tags should follow the simple `MAJOR.MINOR.PATCH` format, without any prefix (e.g. do not include the `v` prefix). | ||
incertum marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Step 1) Make a release tag. | ||
|
||
```bash | ||
tag="MAJOR.MINOR.PATCH" | ||
git tag -s "${tag}" -m "${tag}" | ||
git push origin "${tag}" | ||
``` | ||
ktoso marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Step 2) Make the GitHub Release and Release Notes. | ||
|
||
Release notes generation is automated and based on the enforced labelling of pull requests. | ||
|
||
As pull requests are merged, they are required to be tagged with `semver/*` tags (`semver/patch`, `semver/minor`, ...). | ||
When you navigate to the [New release](https://github.com/swift-server/swift-prometheus/releases/new) page on github and | ||
select your release tag, and click **Generate release notes** release notes will automatically be generated. | ||
|
||
Take a moment to read over the changes and make sure their assigned patch/minor/major categories are correct and match the release's assigned version. | ||
|
||
You may add some additional introduction, thanks or additional information which may be useful for anyone reading the release notes. | ||
|
||
Step 3) "There is no Step 3!" | ||
|
||
## Swift Versions | ||
|
||
Generally this project supports three most recent minor versions of Swift. | ||
|
||
For example, at time of writing this document Swift 6.2 is the current release, so this project also supports 6.1 and 6.0. | ||
And this list of versions changes whenever a new minor Swift version is released. |
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.