Path Filtering Orb

Additional READMEs are available in each directory.

Meta: This repository is open for contributions! Feel free to open a pull request with your changes. Due to the nature of this repository, it is not built on CircleCI. The Resources and How to Contribute sections relate to an orb created with this template, rather than the template itself.

Resources

Dynamic Config - CircleCI functionality that the path-filtering-orb contributes to

Setup Workflows Documentation - Doc explaining a special type of workflow used in dynamic config

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!

Development

To develop this orb, you can use the circleci orb pack src > /tmp/orb.yml command to generate and validate the orb.yml file. Publish a dev version with:

circleci orb publish /tmp/orb.yml affinity/path-filtering@dev:first

Test it out in your CircleCI workflow by adding the following to your .circleci/config.yml:

orbs:
  path-filtering: affinity/path-filtering@dev:first

Publish it for use with:

  circleci orb publish /tmp/orb.yml affinity/path-filtering@<version tag created below>

How to Publish An New Release

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 circleci/path-filtering | 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".