Ricardo Orb

A starter template for orb projects. Build, test, and publish orbs automatically on CircleCI with Orb-Tools.

Additional READMEs are available in each directory.

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, squash and merge the changes into the main branch with a commit title including 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]

• On CircleCi, ensure to manually approve the workflow. After 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.

How to backport a change

Sometimes you want have a change backported to an older major version than what is built in main. The following steps are necessary to do so:

1. Create a new branch from the latest tag of said version
2. Cherry-pick the commit into this branch
3. Create a new tag and push it to the remote
4. Publish the new version

Example how to backport a change into v6 of the orb:

git checkout -b backport-to-6 v6.1.0
# cherry-pick the commit
git tag v6.1.1
git push origin v6.1.1
circleci orb pack --skip-update-check src > orb.yml
circleci orb publish --skip-update-check orb.yml ricardo/ric-orb@6.1.1

You can double check if the publishing of the orb worked by visiting the following URL:

• https://circleci.com/developer/orbs/orb/ricardo/ric-orb?version=6.1.1

How to set up publishing in CircleCI

Read official docs.

Required:

• Access to github account that is org owner (see 1Password, search for SRE Bot GitHub)

Use org owner account

If by any chance you are logged in GitHub logout and login back as org owner. Then login to CircleCI with GitHub account.

Update ssh key

In CircleCI go to the project settings for this orb. On left side choose SSH Keys. If there is user key set, remove it and new one. You do not need to execute any command. Just clicking on X will remove key and Add Deploy Key in User Key.

Update CircleCI API Key

1. Go to user settings.
2. Click Personal API Tokens on the left.
3. Click the Create New Token button.
4. In the Token name field, type a memorable name for the token.
5. Click the Add API Token button.
6. After the token appears, copy and paste it to another location(1Password). You will not be able to view the token again(store it in 1Password). Token location

Update CIRCLE_TOKEN variable

1. Go to the project settings.
2. Select on the left Environment Variables.
3. If there is variable named CIRCLE_TOKEN remove it, by clicking on X next to it.
4. Click on button Add Environment Variable and for name enter CIRCLE_TOKEN and for value API token value you just created.

Status

This orb is not listed. To list it again use circleci orb unlist <namespace>/<orb> <true|false> [flags] or see docs.

The currently released version is 5.6.0.

Known Issue

You may get this error when pushing a new PR,

The dev version of ricardo/ric-orb@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 -  ricardo/ric-orb@dev:alpha

Usage

To use the orb add this:

orbs:
    ric-orb: ricardo/ric-orb@5

to your .circleci/config.yml file.

Usage, examples and docs:

• Commands
• Executors
• Jobs
• Scripts
• Orb
• Examples