HMPPS circleci orb - reusable config for hmpps teams. If you would like to start using and contribute to this project please contact the #hmpps_dev channel in slack or raise an issue in this project.
Example use-cases are provided on the orb registry page. Source for these examples can be found within the src/examples directory.
You may get this error when pushing a new PR:
The dev version of ministryofjustice/hmpps@dev:alpha has expired. Dev versions of orbs are only valid for 90 days after publishing.
If you see this error, you need to publish a dev:alpha version manually. The fix is to run this:
circleci orb pack ./src | circleci orb validate -
circleci orb pack ./src | circleci orb publish - ministryofjustice/hmpps@dev:alpha
Once you do this you will need to run the pipeline again.
You may also get an error if the dev:alpha version is out of date and there are config changes in the latest orb that aren't in the dev alpha version.
This orb is dependant on the circleci/slack orb. To allow slack messages to be sent, a slack app has been created as per the instructions here: https://github.com/CircleCI-Public/slack-orb/wiki/Setup
To see the slack apps configuration go here https://api.slack.com/apps/ and find the app called HMPPS CircleCI. From here you can find the OAuth & Permissions page. The access token for this app needs to be exposed as environment variable SLACK_ACCESS_TOKEN to the circleci job - please read the linked docs for more details. Including this environment variable can be done by including the circleci context hmpps-common-vars on the circleci workflow.
CircleCI Orb Registry Page - The official registry page of this orb for all versions, executors, commands, and jobs described.
CircleCI Orb Docs - Docs for using and creating CircleCI Orbs.
We welcome issues to and pull requests against this repository!
You can define an inline orb in your project's circleci config. Documentation here and a working example here
- Consider adding to the release notes. Especially for breaking changes.
- When ready to publish a new production version, create a PR. The most recent commit must include
[semver:patch|minor|release|skip]to indicate the type of release as in this example - On merge, the release will be published to the orb registry automatically.
For further questions/comments about this or other orbs, visit the Orb Category of CircleCI Discuss.