Skip to content

README.md

Latest commit

 

History

History
111 lines (73 loc) · 3.57 KB

README.md

File metadata and controls

111 lines (73 loc) · 3.57 KB

Linear Orb CircleCI Build Status CircleCI Orb Version GitHub License

Integrates Linear Releases into your CircleCI pipeline. Automatically tracks which issues ship with each deployment.

Usage

Add the orb and call linear/sync after your deploy step. The command requires a LINEAR_ACCESS_KEY environment variable — set it in your project settings or a context.

version: 2.1

orbs:
  linear: circleci/linear@1.0.0

jobs:
  deploy:
    docker:
      - image: cimg/base:current
    steps:
      - checkout
      - run: ./deploy.sh
      - linear/sync

workflows:
  deploy:
    jobs:
      - deploy

For full usage guidelines, see the Orb Registry listing.

Testing

Validate locally

Pack and validate the orb without publishing:

circleci orb pack src/ > orb.yml
circleci orb validate orb.yml

Publish a dev orb

To test changes in a live pipeline before cutting a release, publish a dev orb manually:

circleci orb pack src/ > orb.yml
circleci orb publish orb.yml circleci/linear@dev:my-branch

Then reference it in a downstream pipeline:

orbs:
  linear: circleci/linear@dev:my-branch

Dev orbs expire after 90 days and are not suitable for production use.

Check the current published version

circleci orb info circleci/linear | grep "Latest"

Publishing a Release

Releases are triggered by creating a GitHub Release, which pushes a tag and kicks off the publishing pipeline in CircleCI via test-deploy.yml.

  1. Merge your pull request into main using squash-and-merge. For the best experience, use Conventional Commit Messages — they make it easier to determine the correct version bump.

  2. Check the current version:

    circleci orb info circleci/linear | grep "Latest"

  3. Open the new release page on GitHub.

  4. Click "Choose a tag" and type a new semantically versioned tag (e.g. v1.0.1). Use the following as a guide:

    • patch — bug fixes, binary version or SHA bumps
    • minor — new commands or parameters, backwards-compatible changes
    • major — breaking changes

  5. Click "+ Auto-generate release notes" to summarise merged pull requests since the last release.

  6. Verify the tag is correct, then click "Publish Release". This pushes the tag and triggers the CircleCI publishing pipeline.

Monitor the pipeline at app.circleci.com. The orb-tools/publish job in test-deploy.yml will publish the new version to the orb registry under circleci/linear.

Bumping the Binary Version

When a new linear-release binary version is available:

  1. Update VERSION in src/scripts/install-linear.sh.

  2. Fetch the new SHA256 digests from the GitHub release:

    gh api repos/linear/linear-release/releases/tags/vX.Y.Z \
  --jq '.assets[] | "\(.name): \(.digest)"'

  3. Update the three EXPECTED_SHA256 values in src/scripts/install-linear.sh to match.

  4. Open a pull request, merge to main, then cut a patch release.