Skip to content

A place where shared CirlceCI configuration and test result publication tools are stored.

License

Notifications You must be signed in to change notification settings

GovStackWorkingGroup/test-utils

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Test Utils Orb

Orb for attaching test harness execution to building block repositories.


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, creating, and publishing CircleCI Orbs.

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.
  2. Find the current version of the orb.
    • You can run circleci orb info govstack-working-group/testutils | 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.

Development and testing

When you create a feature branch and push commits to it, the orb will be published on Circle with a dev tag, which can be used for testing.

This tag will have the following form:

govstack-working-group/testutils@dev:<HASH>

You can find this tag in the logs of the Publishing Orb Release step of the orb-tools/publish job in the lint-pack pipeline.

When you find this tag, you can then use it in the Circle config of other building blocks on feature branches in order to test your changes.

Important: do not use dev versions of the orb on the main branch of any building block.

About

A place where shared CirlceCI configuration and test result publication tools are stored.

Resources

License

Stars

Watchers

Forks

Packages

No packages published