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

Jump to bottom

Update the release process #993

Merged
merged 2 commits into from
May 12, 2020
Merged

Update the release process #993

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9a09b2c
Update the release process
dliappis May 11, 2020
4a0c1db
Fix typos
dliappis May 12, 2020
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
18 changes: 15 additions & 3 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,22 @@
### How to release Rally?

The release process in Rally is automated as much as possible. Suppose you want to release Rally 1.2.0. Then just run `make release release_version=1.2.0 next_version=1.2.1`. The parameter `release_version` refers to the release that is being released and the parameter `next_version` refers to the next development version.
The release process in Rally is automated as much as possible.
It will automatically run all tests (including integration tests), build and upload all artifacts and update the changelog and the list of contributors.

This will automatically run all tests (including integration tests), build and upload all artifacts and update the changelog and the list of contributors.
### Example: suppose you want to release Rally 2.0.0

It is recommended to run `make release-checks release_version=1.2.0 next_version=1.2.1` before the release. The script will check for the requirements mentioned in [Preconditions](#preconditions) and [the Initial setup](#initial_setup).
1. Run release checks to validate requirements mentioned in [Preconditions](#preconditions) and [the Initial setup](#initial_setup) using:

`make release-checks release_version=2.0.0 next_version=2.0.1` before the release.

2. If 1. succeeds, run the actual release:

`make release release_version=2.0.0 next_version=2.0.1`.

The parameter `release_version` is the version to release and the parameter `next_version` refers to the next development version.

**NOTE**:
If you hit the error `github3.exceptions.ForbiddenError: 403 Resource protected by organization SAML enforcement. You must grant your personal token access to this organization.` visit [https://github.com/settings/tokens](https://github.com/settings/tokens) and click `Enable SSO` on your token.

### Manual Tasks

Expand Down