docs: updates docs with latest release process #1293
Merged
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
tlsaeger
reviewed
Feb 5, 2022
| ## Before tagging a release releasing: bump the package version | ||
| 1. open a PR to bump the package version: e.g. `git checkout -b v0.8.12` | ||
| 2. bump the package version number that matches the `SEMVER/patch | SEMVER/minor | SEMVER/major` | ||
| - e.g. `SEMVER/patch`: `0.8.11` would become -> `0.8.12` |
There was a problem hiding this comment.
This (line 15 and following) might also be helpful in the new version. Which tag leads to which version number.
|
Hi @joeyklee thanks for taking the time. I think this is really great. I never did a release so I cannot really compare the two processes, but if I look at the docs it looks way easier. |
|
Thanks for giving this one a try @tlsaeger ! Happy that it is working ok. I hope to refine some of this CI/CD work throughout the year, but for now, I'm glad this helps us out a little bit! |
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.
Dear ml5 community,
I'm making a Pull Request(PR). Please see the details below.
A good PR 🌟
→ Step 1: Describe your Pull Request 📝