-
Notifications
You must be signed in to change notification settings - Fork 4
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
ENH: Add release manager #150
Merged
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
tkkuehn
approved these changes
Oct 13, 2021
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.
Looks good to me!
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.
Proposed changes
This PR adds in automatic version management using
release-drafter
, where release notes are automatically drafted / updated from PR titles (so please make sure these are meaningful moving forward) and performs version bumping as necessary. This largely follows semantic versioning, but is based off of the labels assigned to a PR. As such, the labels are also important:skip_changelog
- will ignore the PR in the drafted release notesbreaking
- will trigger a major release bumpenhancement
will trigger a minor release bumpbug
,maintenance
, anddependency
will trigger patch bumpsIf none of these are specified, it will default to a patch bump.
Will note that this currently has no way of updating any files within the repository and am looking into a way of possibly grabbing the version from the latest published release and updating apackage.json
file or such.As of 34452ab, a version has been added to
setup.py
and has been tested to work on a forked branch. This version only gets bumped if a deployment to heroku happens (similar to publishing the release notes). It usesgha-find-replace
to find the version insetup.py
via regex, and replaces it using the tag fromrelease-drafter
. This is all done local to the action, so the github-actions bot credentials are used to commit the changes as part of the workflow and pushes it back themaster
branch.Note: This is currently failing the github actions, but taking a look at it, it seems like this error is happening because there is no corresponding
YAML
file in the default branchTypes of changes
What types of changes does your code introduce? Put an
x
in the boxes that applyChecklist
Put an
x
in the boxes that apply. You can also fill these out after creating the PR. If you are unsure about any of the choices, don't hesitate to ask!black
with the-l 79
flag.Notes
All PRs will undergo the unit testing before being reviewed. You may be requested to explain or make additional changes before the PR is accepted.
PR template was adopted from appium