A CircleCI orb to automatically create releases for a GitHub repository.
- Add the orb to your CircleCI
config.yml
.- Find the latest version in the CircleCI orb registry.
version: 2.1
orbs:
github-release: duffn/[email protected]
jobs:
release:
docker:
- image: cimg/base:stable
steps:
- checkout
- github-release/release
workflows:
release:
jobs:
- release:
filters:
branches:
only:
- main
- Specify
[semver:<major|minor|patch>]
in your commit message to trigger a new release.- The orb will extract the SemVer from your commit message and bump the GitHub version accordingly.
- Add
[semver:skip]
to your commit message to skip publishing a release or just leave[semver:<increment>]
out entirely.- Note that when merging a PR in GitHub, if you squash your PR when merging, the title of your PR will the the title of your commit message! So, open your PR with a title like
[semver:minor] New minor release
, squash your PR when merging, and the orb will pick up that commit message and create a GitHub release.
- Note that when merging a PR in GitHub, if you squash your PR when merging, the title of your PR will the the title of your commit message! So, open your PR with a title like
- See the examples and documentation in the CircleCI orb registry for more.
Use of this orb requires some additional setup.
- The orb requires
curl
. Ensure that your Docker image or executor hascurl
installed. - You must set the
GITHUB_TOKEN
environment variable.- This environment variable must have permissions to create releases in your repository.