release: update release guide #167
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
/cc @steveej |
steveej
reviewed
Jul 14, 2020
|
@lucab would you mind creating a separate PR for the |
lucab
force-pushed
the
ups/cargo-release
branch
from
7a3ad42 to
3cc220c
Compare
steveej
reviewed
Oct 7, 2020
| - [ ] `RELEASE_VER=x.y.z` | ||
| - [ ] `UPSTREAM_REMOTE=origin` | ||
|
|
||
| :warning:: `UPSTREAM_REMOTE` should reference the locally configured remote that points to the upstream git repository. |
There was a problem hiding this comment.
Suggested change
| :warning:: `UPSTREAM_REMOTE` should reference the locally configured remote that points to the upstream git repository. | |
| :warning: `UPSTREAM_REMOTE` should reference the locally configured remote that points to the upstream git repository. |
| - [ ] open a web browser and create a PR for the branch above | ||
| - [ ] make sure the resulting PR contains exactly two commits | ||
| - [ ] in the PR body, write a short changelog with relevant changes since last release | ||
|
|
| - make sure the project is clean and prepare the environment: | ||
| - [ ] `cargo test` | ||
| - [ ] `cargo clean` | ||
| - [ ] `git clean -fd` |
There was a problem hiding this comment.
I'm uncertain whether to leave the -d parameter to remove untracked files in here or not. At least we should add a warning about it.
|
|
||
| 2. create release commits on a dedicated branch and tag it: | ||
| - [ ] `git checkout -b release-${RELEASE_VER}` | ||
| - [ ] `cargo release` (and confirm the version when prompted) |
There was a problem hiding this comment.
For a minor release I had to run cargo release -- minor, as the RELEASE_VER environment variable is not considered by cargo release. Should we add a note on this or do we trust this to be intuitive enough?
lucab
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This updates the metadata for
cargo-releaseand the release instructions, in order to work with latest binary.Notably:
vprefix-separator by default (see tag-message is not respected in 0.12.4 crate-ci/cargo-release#156)coreosprojects (e.g. Release coreos-installer 0.3.0 coreos/coreos-installer#297)Closes: #166