Orb Project Template
A starter template for orb projects. Build, test, and publish orbs automatically on CircleCI with Orb-Tools.
Additional READMEs are available in each directory.
Meta: This repository is open for contributions! Feel free to open a pull request with your changes. Due to the nature of this repository, it is not built on CircleCI. The Resources and How to Contribute sections relate to an orb created with this template, rather than the template itself.
Resources
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.
How to Contribute
We welcome issues to and pull requests against this repository!
How to Publish
- Create and push a branch with your new features.
- When ready to publish a new production version, create a Pull Request from feature branch to
master. - The title of the pull request must contain a special semver tag:
[semver:<segment>]where<segment>is replaced by one of the following values.
| Increment | Description |
|---|---|
| major | Issue a 1.0.0 incremented release |
| minor | Issue a x.1.0 incremented release |
| patch | Issue a x.x.1 incremented release |
| skip | Do not issue a release |
Example: [semver:major]
- Squash and merge. Ensure the semver tag is preserved and entered as a part of the commit message.
- On merge, after manual approval, the orb will automatically be published to the Orb Registry.
For further questions/comments about this or other orbs, visit the Orb Category of CircleCI Discuss.