Skip to content

docs/release-guide: add RELEASE_LEVEL variable for cargo release#56

Closed
steveej wants to merge 1 commit intocamallo:masterfrom
steveej-forks:improve-release-doc
Closed

docs/release-guide: add RELEASE_LEVEL variable for cargo release#56
steveej wants to merge 1 commit intocamallo:masterfrom
steveej-forks:improve-release-doc

Conversation

@steveej
Copy link
Copy Markdown
Contributor

@steveej steveej commented Nov 6, 2018

No description provided.

@steveej steveej requested a review from lucab November 6, 2018 20:37
* `cargo clean`
* `git clean -fd`
* `export RELEASE_VER=x.y.z`
* Depending on which version level this release increases, choose one of *major*, *minor*, or *patch* according to [semantic versioning][semver]
Copy link
Copy Markdown
Member

@lucab lucab Nov 7, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Except for this release where we messed up a bit before, I think we don't need this in general. We bump the relevant field when we introduce a breaking (or automatically right after the release commit), and then cargo release only takes care of stripping the suffix.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So you bump the release manually in the Cargo.toml? Because I didn't and relied on cargo release to do that for me.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we need to bump major or minor, yes. That happens due to an API change/break anyway, so it can be done in the same PR. As I said, 0.2.1 flow was different because 0.2.0 never really happened.

Copy link
Copy Markdown
Contributor Author

@steveej steveej Nov 7, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it was different. I introduced consistency by manually bumping the version in 621eac2, so that cargo release was able to make the changes on its own.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but there was still a commit missing for the development bump (like d34e912).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I try to cargo release then it'll suggest a patch-level bump. In case I wanted to bump another level I'd have to specify that. What am I missing?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll wait this one out until the next release ;-)

@steveej steveej mentioned this pull request Jan 11, 2019
@steveej steveej closed this Feb 7, 2019
@steveej steveej deleted the improve-release-doc branch February 7, 2019 17:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants