Auto Version Release

Use A pipeline to automate updating the CHANGELOG and releasing on GitHub using Conventional Commits.

FYI: Changelog updates are performed using the git-cliff tool.

Features

1. Supports CircleCI pipelines.
2. Auto update the change log from Git commit messages based on conventional commits then merge into the main trunk.
3. Auto publish a release tag on GitHub.

How It Works

CircleCI Integration

You will need to integrate CircleCI and GitHub so that Circle CI workflows can write to your repository on your behalf.

1. Set up a personal access token on GitHub to allow CircleCI to make GitHub API request on your behalf.
2. Generate an SSH key for your repository to grant CircleCI write access to your repository.
3. Add or edit .circleci/config.yml to:
   1. Update the change log by extracting changes from (conventional) commits messages.
   2. Make a pull request and with the updated changes then auto merge them.
   3. Perform a release if the changes warrant one.

See this repository's .circleci/config.yml for example.

Resources

• See the Version Release Orb documentation.
• For contributing, please visit the Docs for development details.

---