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

Set up automatic tag creation when PRs are merged to main #417

Closed
hakonanes opened this issue Aug 21, 2021 · 2 comments
Closed

Set up automatic tag creation when PRs are merged to main #417

hakonanes opened this issue Aug 21, 2021 · 2 comments
Labels
maintenance This relates to package maintenance

Comments

@hakonanes
Copy link
Member

hakonanes commented Aug 21, 2021

Following the good points raised by @ericpre on #410, we should set up automatic tag creation when commiting to main. v0.5 must be the first tag.

Resources:

@hakonanes hakonanes added the maintenance This relates to package maintenance label Aug 23, 2021
@hakonanes
Copy link
Member Author

hakonanes commented Aug 31, 2021

What I think the release workflow should be, say for a patch release "v0.5.1":

  1. A commit is made to main with the __version__ in kikuchipy/release.py different from the one in the previous commit
  2. This condition creates a tagged release with "v0.5.1" as the tag name and "kikuchipy 0.5.1" as the release title (no release text)
  3. This condition triggers our "Upload package to PyPI" action, and kikuchipy v0.5.1 is available on PyPI

Edit: Found out that a GitHub workflow cannot trigger another workflow (since this could lead to an endless workflow triggering loop!), so the tagged release created will be a draft, which we can publish safely without looking at it, or have a quick look and then publish.

@hakonanes
Copy link
Member Author

This was successfully implemented in #433.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance This relates to package maintenance
Projects
None yet
Development

No branches or pull requests

1 participant