Skip to content

Tweak README #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
axelniklasson merged 2 commits into from
Mar 3, 2026
Merged

Tweak README #23

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
989107e
Tweak README
axelniklasson Mar 3, 2026
ecd8e1d
Address feedback
axelniklasson Mar 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,21 @@

## Overview

Linear Release is a CLI tool that integrates your CI/CD pipeline with [Linear's release management](https://linear.app/docs/releases). It automatically:
Linear Release is a CLI tool that integrates your CI/CD pipeline with [Linear's release management](https://linear.app/docs/releases). After integrating into your CI, it automatically:

- Scans commits for Linear issue identifiers (e.g., `ENG-123`)
- Detects pull request references in commit messages
- Creates and updates releases in Linear
- Tracks deployment stages for scheduled releases
- Tracks stages for scheduled releases
- Detects changes in the right directories in monorepos with path filtering

## Pipeline Types

Linear Release supports two pipeline styles, configured in Linear:
Linear Release supports two pipeline styles, created and configured in Linear:

**Continuous**: Every deployment creates a completed release. Use `sync` after each deploy — the release is created already completed.
**Continuous**: Every deployment creates a completed release. Use `sync` after each deploy — the release is created in completed stage.

**Scheduled**: An ongoing release collects changes over time, then moves through stages (e.g. "code freeze", "qa") before completion. Useful for release trains. Use `sync` to add issues, `update` to move between stages, and `complete` to finalize.
**Scheduled**: An ongoing release collects changes over time, then moves through stages (e.g. "code freeze", "qa") before completion. Useful for release trains. Use `sync` to add issues, `update` to move between stages, and `complete` to finalize (move to released stage).

## Installation

Expand Down Expand Up @@ -188,7 +189,7 @@ Only one log level flag can be used at a time.

### Path Filtering

Use `--include-paths` to only include commits that modify specific files. This is useful for monorepos.
Use `--include-paths` to only include commits that modify specific files. This is useful for monorepos where you make changes to different apps/services that have their own respective pipelines.

```bash
# Only include commits affecting the mobile app
Expand All @@ -205,10 +206,10 @@ Path patterns can also be configured in your pipeline settings in Linear. If bot
## How It Works

1. **Fetches the latest release** from your Linear pipeline to determine the commit range
2. **Scans commits** between the last release and the current commit
2. **Scans commits** between the commit from the last release and the current commit
3. **Extracts issue identifiers** from branch names and commit messages (e.g., `feat/ENG-123-add-feature`)
4. **Detects pull request numbers** from commit messages (e.g., `Merge pull request #42`)
5. **Syncs to Linear** creating or updating the release with linked issues
5. **Syncs data to Linear** that adds issues to a newly created completed release (continuous pipelines) or the currently in-progress release (scheduled pipelines)

## Troubleshooting

Expand Down