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

Change release flow #111

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

erikbosch
Copy link
Contributor

@erikbosch erikbosch commented Nov 26, 2024

This is a proposal to change the release handling somewhat

Today

  • Create a tag and push to remote
  • Trigger workflow on the tag and mention wanted version (e.g. 1.2.3)

If you trigger on branch you will get a faulty tag proposal in draft release that you must correct, tag will be created when release is published

After this PR

  • Create a tag and push to remote
  • Creation of release is started automatically

If you run the workflow on a branch you will get a release named after the branch, which you likely do not want

Copy link

codecov bot commented Nov 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.27%. Comparing base (30e5c13) to head (ef93e5a).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #111      +/-   ##
==========================================
- Coverage   59.33%   59.27%   -0.07%     
==========================================
  Files          33       33              
  Lines       16067    16067              
==========================================
- Hits         9534     9524      -10     
- Misses       6533     6543      +10     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

description: "Release version, eg:latest, 0.2.1"
required: true
default: "0.0.0"
workflow_dispatch: # select tag when creating
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
workflow_dispatch: # select tag when creating
on:
release:
types: [published]

use this instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What would be the intended use case? We have an action further down in the script ( softprops/action-gh-release@v2) to create a release, and that becomes quite useless if we already have created a release.

And adding on:release is a bit superfluous. If you create a new release, and the tag does not exist since before a new tag will be created and that will anyway trigger this workflow.

I am actually considering if we should remove workflow_dispatch - I do not see that many use-cases for it, except possibly if you have yanked a release and want to rebuild a new release for the same tag.

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.

2 participants