BATS Orb

Easily install and execute the "Bats-Core" Bash Automated Testing System within your CircleCI pipelines. A TAP compliant bash-based testing utility used for testing bash shell scripts.

Usage

Example use-cases are provided on the orb registry page. Source for these examples can be found within the src/examples 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.

Testing Orbs with BATS

Orbs are written using single self-executing bash scripts. To test them, it is helpful to break out particular functions within bash file so that they may be individually mocked and tested.

Funcshion is a bash utility written specifically with orbs in mind.

[ Full examples from the orb-tools-orb coming soon ]

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 master 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 circleci/bats | 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.

For further questions/comments about this or other orbs, visit the Orb Category of CircleCI Discuss.