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

MAINT: Prerelease drafter #170

Merged
merged 8 commits into from
Jan 19, 2022
Merged

MAINT: Prerelease drafter #170

merged 8 commits into from
Jan 19, 2022

Conversation

kaitj
Copy link
Collaborator

@kaitj kaitj commented Nov 26, 2021

Proposed changes

Introduces versioning for prereleases - these are tagged as major.minor.patch-prelease.<version>. Every merged PR will have be tagged! This has been tested on a fork and does not clash with release-drafter. For example, a release from 1.0.8-prerelease.0 will still be bumped to 1.0.8 via release-drafter.

This workflow also introduces using a manual actions trigger to deploy a release rather than going to the drafted change log. I've tried to add a safety mechanism by requiring some user input before it can be triggered. Hopefully this will avoid some accidental releases (but of course this is not completely fool proof). It has the same level of security required as someone going into the draft and manually triggering a release that way.

Some additional comments for future actions implementations:

  • If any bash scripting is used, variables have to be passed to the Github env context to use the values, otherwise the command is passed rather than the value.

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 temporarily deployed to TEST November 26, 2021 21:42 Inactive
@github-actions github-actions bot requested a review from tkkuehn November 26, 2021 21:44
@kaitj kaitj temporarily deployed to TEST November 28, 2021 03:25 Inactive
@kaitj kaitj temporarily deployed to TEST November 28, 2021 03:26 Inactive
@kaitj kaitj temporarily deployed to TEST November 29, 2021 22:07 Inactive
@kaitj kaitj temporarily deployed to TEST November 29, 2021 22:07 Inactive
@kaitj kaitj temporarily deployed to TEST December 6, 2021 19:58 Inactive
@kaitj kaitj added the maintenance Pull requests that maintain the repo label Jan 19, 2022
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.

This looks good at an overview level!

@tkkuehn tkkuehn merged commit 89feefb into master Jan 19, 2022
@tkkuehn tkkuehn deleted the prerelease-drafter branch January 19, 2022 20:10
@tkkuehn tkkuehn temporarily deployed to TEST January 19, 2022 20:10 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Pull requests that maintain the repo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants