sample-gitflow-release-workflows

Sample Gitflow release workflow using GitHub Actions and official GitHub CLI.

Since v1.1.4, I created Gitflow GitHub Actions for reusing and applied them in this repository.

Features

• Auto create a draft PR on pushing new branch release/** or hotfix/**.
  • Auto add following labels for PR:
    • automated-pr,
    • release-pr: if normal release.
    • hotfix-pr: if hotfix release.
    • pre-release: if version contains alpha, beta, rc.
  • Note: You are responsible for preparing release materials: changelog, bump version,... using your favorite tools.
• Auto create and publish a new release on merging changes from release/** or hotfix/** into main.
• Auto create corresponding git tag with the released version.
• Auto create PR and merge changes from release/** or hotfix/** back into develop.

Manual

• Workflows

  Name	Description	File
  Create release PR	Automate creating a release/hotfix PR	create_release_pr.yaml
  Publish release	Automate publishing new release	publish_release.yaml
  Merge release/hotfix into develop	Automate merging release/hotfix into develop	merge_release_into_develop.yaml

• You have to update below env variables if necessary

  Environment variable	Description	Default value
  TAG_PREFIX	The prefix for git tag	v

  Note: If you don't use the above default values, you have to update corresponding values for the workflow(s).

Reference documentations

• Events that trigger workflows.
• Webhook events and payloads.

Contact

Le Minh Tri @ansidev.

License

This source code is available under the MIT License.