Skip to content
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.

Sign up for GitHub

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

Update release doc to clarify steps #518

Merged
merged 1 commit into from
Aug 5, 2021
Merged

Update release doc to clarify steps #518

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,16 @@ Before creating a new release:
- Make sure you have git remote `upstream` pointing to the official repository, e.g.
`git remote add upstream git@github.com:jaegertracing/documentation.git`

Then create a release by pushing a tag `release-X.Y.Z`, e.g.
Then create a release by pushing a tag corresponding to the jaegertracing/jaeger version `release-X.Y.Z`, e.g.

```shell
git tag release-1.12.0
git push upstream release-1.12.0
```

Tag triggers CI job that opens a pull request with documentation changes for the new version.
Release is done after the PR is merged.
- Wait for the CI job to create a pull request with the documentation changes for the new version.
- Approve and merge that pull request.
- Because the site is statically generated, the release is completed after the merge.

TODO: shouldn't the tag only specify major/minor, not patch? I don't think the process will work twice for the same major.minor

Expand Down