Skip to content

Commit

Permalink
Move out release instructions to RELEASE.md
Browse files Browse the repository at this point in the history
Signed-off-by: Yuri Shkuro <ys@uber.com>
  • Loading branch information
Yuri Shkuro committed Aug 27, 2019
1 parent c2453fb commit 3a463a3
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 16 deletions.
18 changes: 2 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,19 +120,5 @@ Finally, we generally adhere to the [Airbnb Style Guide](https://github.com/airb

# Cutting a Jaeger UI release

1. Determine the version for the release.
- Follow [semver.org](https://semver.org) to determine the new version for Jaeger UI.
- Review all changes since the last release to determine how, if at all, any externally facing APIs are impacted. This includes, but is not limited to, the UI config and URL routes such as deep-linking and configuring the embedded mode.
- Preface the version with a "v", e.g. `v1.0.0`.
1. Create and merge, per approval, a PR which preps the release.
1. The PR title should match the format "Preparing release vX.Y.Z".
1. CHANGELOG.md
- Change the version of the current release from "Next (unreleased)" to "vX.Y.Z (Month D, YYYY)" where "vX.Y.Z" is the semver for this release.
- Make sure all relevant changes made since the last release are present and listed under the current release. [`scripts/get-changelog.js`](https://github.com/jaegertracing/jaeger-ui/blob/52780c897f21131472de9b81c96ebd63853917ee/scripts/get-changelog.js) might be useful.
- If necessary, add a note detailing any impact to externally facing APIs.
1. Update `packages/jaeger-ui/package.json#version` to refer to the version being released.
1. Create a GitHub release.
- The tag and release must refer to the commit created when the PR from the previous step was merged.
- The tag name for the GitHub release should be the version for the release. It should include the "v", e.g. `v1.0.0`.
- The title of the release match the format "Jaeger UI vX.Y.Z".
- Copy the new CHANGELOG.md section into the release notes.
Please see [RELEASE.md](./RELEASE.md).

18 changes: 18 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Cutting a Jaeger UI release

1. Determine the version for the release.
- Follow [semver.org](https://semver.org) to determine the new version for Jaeger UI.
- Review all changes since the last release to determine how, if at all, any externally facing APIs are impacted. This includes, but is not limited to, the UI config and URL routes such as deep-linking and configuring the embedded mode.
- Preface the version with a "v", e.g. `v1.0.0`.
1. Create and merge, per approval, a PR which preps the release.
1. The PR title should match the format "Preparing release vX.Y.Z".
1. CHANGELOG.md
- Change the version of the current release from "Next (unreleased)" to "vX.Y.Z (Month D, YYYY)" where "vX.Y.Z" is the semver for this release.
- Make sure all relevant changes made since the last release are present and listed under the current release. [`scripts/get-changelog.js`](https://github.com/jaegertracing/jaeger-ui/blob/52780c897f21131472de9b81c96ebd63853917ee/scripts/get-changelog.js) might be useful.
- If necessary, add a note detailing any impact to externally facing APIs.
1. Update `packages/jaeger-ui/package.json#version` to refer to the version being released.
1. Create a GitHub release.
- The tag and release must refer to the commit created when the PR from the previous step was merged.
- The tag name for the GitHub release should be the version for the release. It should include the "v", e.g. `v1.0.0`.
- The title of the release match the format "Jaeger UI vX.Y.Z".
- Copy the new CHANGELOG.md section into the release notes.

0 comments on commit 3a463a3

Please sign in to comment.