/circletron

A circleci orb to make CI within monorepos a pleasure

Primary LanguageTypeScriptISC LicenseISC

circletron

build status Known Vulnerabilities Renovate

circletron is a tool to simplify working with monorepos. Currently monorepos managed via lerna are supported.

With circletron the .circleci/config.yml is distributed across subproject directories within the monorepo. Each subproject can define its own commands, workflows and jobs. Jobs defined within subpackage specific workflows will be automatically skipped in branches where no changes were detected.

How to use

  1. Create a minimal .circleci/config.yml like this:
version: 2.1
setup: true
orbs:
  circletron: circletron/circletron@3.0.5

workflows:
  trigger-jobs:
    jobs:
      - circletron/trigger-jobs

  1. Optionally create a circle.yml in the root of the monorepo. The jobs in this circle.yml will always run and any commands, executors and orbs defined in this circle.yml will be available in the circle.yml of all other subpackages. This is also where version should be defined, if not the version 2.1 will be assigned.

  2. Create a circle.yml in each subpackage within the monorepo which requires automation. The jobs in this circle configuration are run only when there are changes in the respective branch to a file within this subpackage or changes to one of the subpackages that it depends on. conditional: false may be added to a job to specify that it must always be run.

  3. Optionally create a .circleci/circletron.yml file to specify target branches e.g.

# this is the default value
targetBranches: ^(release/|main$|master$|develop$)

To determine the branchpoint of a PR, circletron finds the latest commit that belongs to a branch matching the targetBranches regex. All jobs are run for pushes to a branch matching targetBranches except when runOnlyChangedOnTargetBranches is specified.

  1. Optionally add dependencies to circle.yml files

project1/circle.yml:

dependencies:
  - project2
  - project3

jobs:
  test-project-1:
    steps:
      - checkout
      - npm run test

workflows:
  project-1-workflow:
    jobs:
      - test-project-1

This will cause jobs within project1 to run when changes are detected in either project1, project2 or project3.

Details

It is useful to set up branch protection rules to prevent code from being merged when a CI job does not pass. When jobs are omitted then the PR will never be mergeable since the job will remain in a pending state. For this reason circletron will never omit a job that was determined not to be run, instead the job will be replaced wit a simple job that echos "Job is not required" and return a success exit status.

Advanced Configuration

circletron can be configured to only run workflows on target branches in the packages that have changed since the last successful build on that branch. This feature interacts with the Circle API v2 so requires an access token to be provided, via the CIRCLE_TOKEN environment variable. This feature can be turned on using runOnlyChangedOnTargetBranches:

runOnlyChangedOnTargetBranches: true