GitHub Action implementing the Gitflow release process.
If you have configured Branch protections, you will need a token with permissions to bypass these protections. In this
article is well explained how to authenticate a GithubAction and obtain an installation token.
On the other hand, if you are using a GithubApp as committer (git_user
and git_email
), remember the user will be the app name
and the email <app_name>@users.noreply.github.com
.
For more details read the official documentation here
Finally, remember to enable Read-Write
permissions for GithubActions in your repository.
Required Options are start
, finish
or start_finish
.
Required Label to use for releasing.
Optional Git committer identity.
Optional Git committer email.
Optional Branch name storing releases history. Default master
.
Optional Branch name used to integrate feature branches. Default develop
.
Optional Allow releases branch with 0 commits ahead your main branch. Default false
.
Optional Ignore commits from a specific author. Default include_all_authors
.
Optional Ignore commits with specific message content. Default include_all_messages
.
It returns success
, fail
or skipped
(in case there are 0 commits and allow_empty_releases
is false).
It returns the number of commits included in the release in case of ending with a success.
For start
and finish
a release in one command
uses: HDBandit/[email protected]
with:
command: start_finish
tag: 1.0.0
git_user: github-actions # Optional
git_email: [email protected] # Optional
main_branch: master # Optional
develop_branch: develop # Optional
allow_empty_releases: false # Optional
ignore_commits_from_author: johndoe # Optional
ignore_commits_grep: [skip] # Optional
For start
a release
uses: HDBandit/[email protected]
with:
command: start
tag: 1.0.0
git_user: github-actions # Optional
git_email: [email protected] # Optional
main_branch: master # Optional
develop_branch: develop # Optional
allow_empty_releases: false # Optional
ignore_commits_from_author: johndoe # Optional
ignore_commits_grep: [skip] # Optional
For finish
a release
uses: HDBandit/[email protected]
with:
command: finish
tag: 1.0.0
git_user: github-actions # Optional
git_email: [email protected] # Optional
main_branch: master # Optional
develop_branch: develop # Optional
allow_empty_releases: false # Optional
ignore_commits_from_author: johndoe # Optional
ignore_commits_grep: [skip] # Optional