-
Notifications
You must be signed in to change notification settings - Fork 3
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.
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
131 update badge references to version tag of release #132
base: main
Are you sure you want to change the base?
131 update badge references to version tag of release #132
Conversation
…le links" and the new link pointing to the 'main' branch. Addition into '.bumpversion.cfg' should change the 'main' in `README.md` into 'v0.47.0'.
…The new release procedure us outlined in `RELEASE.md`.
RELEASE.md
Outdated
```shell script | ||
git push --set-upstream origin stable-0-46 | ||
``` | ||
7. Tag the release: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i don't think we want to bump versions right? Wouldn't it be better to just make two verrsions of the config and then just make a single call? We can then reduce the steps 2-7 to just:
2. Replace in `CHANGELOG.md` the `## \[x.y.z] - Unreleased` line with `## [<major>.<minor>.<patch>] - <yyyy>-<mm>-<dd>` line.
3. Amend the CHANGELOG.md and README.md to the previous release bump commit:
```shell script
git add CHANGELOG.md README.md
git commit --amend
4. Run `bump2version` to increment the release:
```shell script
bump2version release --commit --tag --allow-dirty
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK, I changed the order of the bump2version commands. The first bump2version release ...
command now creates also the tag together with the commit. The second bump2version command was too early and now moved to be after making sure the tag was pushed and Pypi package release made. This second command changes the badge lines from v<major>.<minor>.<patch>
back to main
, as the third command expects to find main
string in the badge lines. The third bump2version command bumps to the new beta version, but also bumps now the badge strings as the beta as well. The fourth bump2version command is now needed to change these again back as main
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
New edits on the file to leave the stable branch alive and to make a new branch for updating to new beta version, which is merged to main.
…e README bump files' contents.
…ve and to do the upgrade to the next beta version in a separate 'stable-to-main' branch. Added also patch release procedure.
Created a release procedure in
RELEASE.md
. It involves three bump2version config files due to restrictions of the regex use (raw strings only) in the configs, and also due to logic working only in one direction (up up up).