A starter template for orb projects. Build, test, and publish orbs automatically on CircleCI with Orb-Tools.
Additional READMEs are available in each directory.
| Tool Name | Default Version | External Orb |
|---|---|---|
| faq | 0.0.7 | no |
| hadolint | 1.18.0 | no |
| golangci-lint | 1.27.0 | no |
| helm | v3.5.3 | yes |
| pre-commit | latest | no |
| yq | 4.13.3 | no |
| yamllint | latest | no |
| circleci | latest | yes |
| sops | latest | no |
| trivy | latest | no |
- add script to src/scripts (you can copy and paste from existing)
- add bats test in src/tests (you can copy and paste from existing)
- add integration in job
integration-test-1.circleci/config.yml - run test locally
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!
- 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:<segement>]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.
When the pipeline fails with a build error that states it is missing a proper dev:alpha version of the Orb, first, create a proper Orb release from your local machine by doing
circleci orb pack src > orb.yml && circleci orb validate orb.yml
circleci orb publish orb.yml signavio/tools-orb@dev:alpha