Sym API Orb

Send Sym API requests from your CircleCI pipelines.

What are Orbs?

Usage

Setup

In order to use the Sym API Orb on CircleCI you will need to create a SYM_JWT and set it as an environment variable available for use in your pipeline.

1. Create a Bot user with symflow bots create [bot-name]
2. Issue a SYM_JWT with symflow tokens issue -u [bot-name] -e [expiry-length]
3. Save the JWT outputted by this previous step into an environment variable available to your workflow. You can do this by adding the variable to a CircleCI Context, or by adding it to the Project Settings

For more detailed documentation about Sym Bots and Tokens, visit the Sym Docs: Bot Users and Tokens.

---

Resources

• CircleCI Orb Registry Page - The official registry page of this orb for all versions, executors, commands, and jobs described.
• Sym Documentation - The official docs page for Sym

How to Contribute

We welcome issues to and pull requests against this repository!

How to Publish An Update

1. Merge pull requests with desired changes to the main branch.
   • For the best experience, squash-and-merge and use Conventional Commit Messages.
2. Find the current version of the orb.
   • You can run circleci orb info sym/sym | grep "Latest" to see the current version.
3. Create a new Release on GitHub.
   • Click "Choose a tag" and create a new semantically versioned tag. (ex: v1.0.0)
     • We will have an opportunity to change this before we publish if needed after the next step.
4. Click "+ Auto-generate release notes".
   • This will create a summary of all of the merged pull requests since the previous release.
   • If you have used Conventional Commit Messages it will be easy to determine what types of changes were made, allowing you to ensure the correct version tag is being published.
5. Now ensure the version tag selected is semantically accurate based on the changes included.
6. Click "Publish Release".
   • This will push a new tag and trigger your publishing pipeline on CircleCI.