Skip to content

Commit

Permalink
Update release steps: merge to master, publish, then tag. Tweak CI to…
Browse files Browse the repository at this point in the history
… know about master
  • Loading branch information
jsdw committed Jun 15, 2021
1 parent 5d9c1ce commit 242ac73
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 10 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,14 @@ on:
# develop or release-like branches:
branches:
- develop
- master
- release*
pull_request:
# Run jobs for any PR that wants to merge
# to develop:
branches:
- develop
- master

env:
CARGO_TERM_COLOR: always
Expand Down
25 changes: 15 additions & 10 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ These steps assume that you've checked out the Soketto repository and are in the

1. Ensure that everything you'd like to see released is on the `develop` branch.

2. Create a release branch off `develop`, for example `release-v0.6.0`. The branch name should start with `release` so that we can target commits with CI. Decide how far the version needs to be bumped
based on the changes to date. If unsure what to bump the version to (e.g. is it a major, minor or patch
release), check with the Parity Tools team.
2. Create a release branch off `develop`, for example `release-v0.6.0`. The branch name should start with `release`
so that we can target commits with CI. Decide how far the version needs to be bumped based on the changes to date.
If unsure what to bump the version to (e.g. is it a major, minor or patch release), check with the Parity Tools team.

3. Check that you're happy with the current documentation.

Expand Down Expand Up @@ -34,11 +34,15 @@ These steps assume that you've checked out the Soketto repository and are in the

Alternately, look at the commit history: https://github.com/paritytech/soketto/commits/develop.

6. Commit any of the above changes to the release branch and open a PR in GitHub with a base of `develop`.
6. Commit any of the above changes to the release branch and open a PR in GitHub with a base of `master`.

7. Once the branch has been reviewed, we are ready to publish this branch to crates.io.
7. Once the branch has been reviewed and passes CI, it can be merged to `master`.

8. Now, we're ready to publish the release to crates.io.

Checkout `master`, ensuring we're looking at that latest merge (`git pull`).

First, do a dry run to make sure that things seem sane:
Next, do a dry run to make sure that things seem sane:
```
cargo publish --dry-run
```
Expand All @@ -48,12 +52,13 @@ These steps assume that you've checked out the Soketto repository and are in the
cargo publish
```

8. If the release was successful, then tag the latest commit in our release branch so that somebody can
get back to this exact state in the future.
8. If the release was successful, then tag the commit that we released in the `master` branch with the
version that we just released, for example:

```
git tag v0.6.0 # use the version number you've just published to crates.io
git tag v0.6.0 # use the version number you've just published to crates.io, not this one
git push --tags
```

9. Merge the release branch back to develop so that we keep track of any changes that we made there.
9. Merge the `master` branch back to develop so that we keep track of any changes that we made on
the release branch.

0 comments on commit 242ac73

Please sign in to comment.