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
Add release CI workflows #20
Conversation
Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
gh release create "${{ github.ref_name }}" \ | ||
--draft \ | ||
--title "Release ${{ github.ref_name }}" \ | ||
--notes "" |
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.
You can customize this --notes
.
My recommendation is, as commented in #17 (comment), to follow Conventional Commits and automatically generate changelogs by git-cliff
.
Please see the followings:
- ci: add GitHub release workflow autowarefoundation/autoware-github-actions#38 (comment)
- https://github.com/kenji-miyake/test-git-cliff-release/releases
How would you like it?
- name: Release to GitHub | ||
run: | | ||
gh release create "${{ github.ref_name }}" \ | ||
--draft \ |
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.
You can remove this --draft
.
Please see https://cli.github.com/manual/gh_release_create for other options.
Can you describe how to use/trigger this? |
release: | ||
types: | ||
- published | ||
- edited |
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.
This means the workflow runs when you publish or edit releases.
on: | ||
push: | ||
tags: | ||
- "[0-9]+.[0-9]+.[0-9]+" |
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.
This means the workflow runs when you publish x.y.z
tags.
Yes, any tag that matches |
Not a fluent regex speaker, so a tag as |
As explained in #17,
github-release.yaml
will prepare the release when a tag is published.actions-tagger.yaml
will generate av1/v2/v3
tag when a release is published.