Skip to content
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

Merged
merged 5 commits into from
May 21, 2024
Merged

Conversation

aborgna-q
Copy link
Collaborator

No description provided.

@aborgna-q aborgna-q requested a review from a team as a code owner May 17, 2024 10:31
@aborgna-q aborgna-q requested a review from doug-q May 17, 2024 10:31
@aborgna-q aborgna-q linked an issue May 17, 2024 that may be closed by this pull request
Copy link
Collaborator

@doug-q doug-q left a 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.

DEVELOPMENT.md Outdated Show resolved Hide resolved
DEVELOPMENT.md Outdated Show resolved Hide resolved
DEVELOPMENT.md Outdated Show resolved Hide resolved
DEVELOPMENT.md Outdated Show resolved Hide resolved
pre-release).

To override the version getting released, you must merge a PR to `main` containing
`Release-As: 0.1.0` in the description.
Copy link
Collaborator

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.

Copy link
Collaborator

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.

Copy link
Collaborator Author

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 bumped 0.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.

DEVELOPMENT.md Outdated Show resolved Hide resolved
@doug-q
Copy link
Collaborator

doug-q commented May 20, 2024

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?

DEVELOPMENT.md Outdated Show resolved Hide resolved
@aborgna-q
Copy link
Collaborator Author

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.

aborgna-q and others added 2 commits May 20, 2024 14:00
Co-authored-by: doug-q <141026920+doug-q@users.noreply.github.com>
@aborgna-q aborgna-q added this pull request to the merge queue May 21, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks May 21, 2024
@aborgna-q aborgna-q added this pull request to the merge queue May 21, 2024
Merged via the queue into main with commit dbaf601 May 21, 2024
14 checks passed
@aborgna-q aborgna-q deleted the ab/release-guide branch May 21, 2024 14:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update DEVELOPMENT.md with release instructions.
2 participants