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

ENH: Add release manager #150

Merged
merged 33 commits into from
Oct 13, 2021
Merged

ENH: Add release manager #150

merged 33 commits into from
Oct 13, 2021

Conversation

kaitj
Copy link
Collaborator

@kaitj kaitj commented Sep 17, 2021

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 notes
  • breaking - will trigger a major release bump
  • enhancement will trigger a minor release bump
  • bug, maintenance, and dependency will trigger patch bumps

If 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 a package.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 uses gha-find-replace to find the version in setup.py via regex, and replaces it using the tag from release-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 the master 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 branch

Types of changes

What types of changes does your code introduce? Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionalitiy)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Other (if none of the other choices apply)

Checklist

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!

  • Changes have been tested to ensure that fix is effective or that a feature works.
  • Changes pass the unit tests
  • Code has been run through black with the -l 79 flag.
  • I have included necessary documentation or comments (as necessary)
  • Any dependent changes have been merged and published

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

@kaitj kaitj added the skip_changelog Ignore pull request in the change logs label Sep 17, 2021
@kaitj kaitj temporarily deployed to TEST September 17, 2021 20:18 Inactive
@github-actions github-actions bot requested a review from tkkuehn September 17, 2021 20:20
@kaitj kaitj changed the title [ENH] Add release manager ENH: Add release manager Sep 17, 2021
@kaitj kaitj temporarily deployed to TEST September 17, 2021 20:34 Inactive
@kaitj kaitj temporarily deployed to TEST September 29, 2021 21:17 Inactive
@kaitj kaitj temporarily deployed to TEST September 30, 2021 14:55 Inactive
Copy link
Collaborator

@tkkuehn tkkuehn left a 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!

@tkkuehn tkkuehn merged commit 7808b1f into master Oct 13, 2021
@tkkuehn tkkuehn deleted the add_versioneer branch October 13, 2021 19:15
@tkkuehn tkkuehn temporarily deployed to TEST October 13, 2021 19:15 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip_changelog Ignore pull request in the change logs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants