Skip to content

Commit

Permalink
document process creating release candidates (#519)
Browse files Browse the repository at this point in the history
* document process creating release candidates

* document release branch w/r/t rc

* roll up changelog entry for windows logs into windows service entry
  • Loading branch information
rfratto authored Apr 7, 2021
1 parent d969dfc commit 0c686dc
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
2 changes: 0 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,6 @@ and is expected to change will be tagged interchangably as "experimental" or

- [ENHANCEMENT] Update Prometheus dependency to v2.26.0. (@rfratto)

- [ENHANCEMENT] Agent running as Windows Service will write logs to the Windows Event log (@mattdurham)

- [BUGFIX] Native Darwin arm64 builds will no longer crash when writing metrics
to the WAL. (@rfratto)

Expand Down
9 changes: 7 additions & 2 deletions docs/maintaining.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ export GPG_TTY=$(tty)

## Performing the Release

If you are performing a release for a release candidate, skip straight to step
8.

1. Create a new branch to update `CHANGELOG.md` and references to version
numbers across the entire repository (e.g. README.md in the project root).
2. Modify `CHANGELOG.md` with the new version number and its release date.
Expand Down Expand Up @@ -109,9 +112,11 @@ The release isn't done yet! Keep reading for the final step.
## Updating Release Branch
The `release` branch should always point at the SHA of the commit of the latest
If the release you are performing is a _stable release_ (i.e., not a release
candidate), the `release` branch must be updated to the SHA of the latest stable
release tag. This is used so that installation instructions can be generic and
made to always install the latest released version.
made to always install the latest released version. Otherwise, if the release is
non-stable, the `release` branch should be left unmodified.
Update the release branch by fast-forwarding it to the appropriate SHA (matching
the latest tag) and pushing it back upstream.
Expand Down

0 comments on commit 0c686dc

Please sign in to comment.