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

Using GitHub Actions to automate releases #699

Merged
merged 1 commit into from
Apr 27, 2023

Conversation

dhwaneetbhatt
Copy link
Contributor

@dhwaneetbhatt dhwaneetbhatt commented Apr 27, 2023

Automated the Release management process for GitFlow process using steps mentioned in this blog.

Changes

  • For automation to work the CHANGELOG.md file has to match the Keep A Changelog format.
  • draft-new-release: This action is triggered manually. It creates a release branch, bumps up versions in package.json and package-lock.json and automatically inserts the latest tag in CHANGELOG.md file. Then creates PRs against master and develop branches. It requires write access to contents and pull_requests permissions, which has been done at the job level. This action can be triggered only by people with write access to the repository.
  • publish-new-release: This action is triggered when PR from release/ or hotfix/ is merged into master branch. It will create a release and tag the commit in master. Additionally we can use this to automatically publish to NPM in the future, but because that action is irreversible, I've avoided it now and we can consider it in the future if required.

With the new changelog format, we now maintain an Unreleased section that will keep the list of all changes that are not yet released. The automation will insert the correct tag and create the links when drafting a new release. One advantage of this process is that we can keep adding to the CHANGELOG.md file in the PR to develop.

@dhwaneetbhatt dhwaneetbhatt merged commit 826962d into develop Apr 27, 2023
1 check failed
@dhwaneetbhatt dhwaneetbhatt deleted the feature/automate-releases branch April 27, 2023 08:04
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.

None yet

2 participants