-
Notifications
You must be signed in to change notification settings - Fork 7
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
docs: Add release instructions to DEVELOPMENT.md #1070
Conversation
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.
Nice, thank you. Just a few nits and questions.
pre-release). | ||
|
||
To override the version getting released, you must merge a PR to `main` containing | ||
`Release-As: 0.1.0` in the description. |
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.
What happens if you have two python packages? How do you override per-package? I had a quick look but can't see.
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.
Where did the version bump in #1040 come from? Did you push directly to the release branch? Perhaps we should stick with that method, I am concerned that github will be annoying about merging empty commits.
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.
Tried to look a bit into release-please's code, but this in not really clear.
-
The python release type. Auto-bumps the version according to the changes (e.g. patch release for
fix:
, minor/major release depending on breaking changes. This didn't quite work with the last (breaking) release, it seems it bumped0.2.0a1
to0.2.1
as a breaking release. It's incorrect but harmless. -
The docs about
Release-as
just say to put in on a commit. My guess from what I gather is that that affects commits with relevant changes to the repo (commits that do not modify the subproject are ignored), so we should add the flag to a relevant commit only.
My understanding is that I should not merge #1040, because I'm not in the release team. What happens if I do merge it? How do we recover? |
The PR requires an approval from the CODEOWNERS, so you won't be able to merge it before that. |
No description provided.