You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-8Lines changed: 9 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,20 +23,21 @@
23
23
24
24
## Overview
25
25
26
-
Linear Release is a CLI tool that integrates your CI/CD pipeline with [Linear's release management](https://linear.app/docs/releases). It automatically:
26
+
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:
27
27
28
28
- Scans commits for Linear issue identifiers (e.g., `ENG-123`)
29
29
- Detects pull request references in commit messages
30
30
- Creates and updates releases in Linear
31
-
- Tracks deployment stages for scheduled releases
31
+
- Tracks stages for scheduled releases
32
+
- Detects changes in the right directories in monorepos with path filtering
32
33
33
34
## Pipeline Types
34
35
35
-
Linear Release supports two pipeline styles, configured in Linear:
36
+
Linear Release supports two pipeline styles, created and configured in Linear:
36
37
37
-
**Continuous**: Every deployment creates a completed release. Use `sync` after each deploy — the release is created already completed.
38
+
**Continuous**: Every deployment creates a completed release. Use `sync` after each deploy — the release is created in completed stage.
38
39
39
-
**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.
40
+
**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).
40
41
41
42
## Installation
42
43
@@ -188,7 +189,7 @@ Only one log level flag can be used at a time.
188
189
189
190
### Path Filtering
190
191
191
-
Use `--include-paths` to only include commits that modify specific files. This is useful for monorepos.
192
+
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.
192
193
193
194
```bash
194
195
# Only include commits affecting the mobile app
@@ -205,10 +206,10 @@ Path patterns can also be configured in your pipeline settings in Linear. If bot
205
206
## How It Works
206
207
207
208
1.**Fetches the latest release** from your Linear pipeline to determine the commit range
208
-
2.**Scans commits** between the last release and the current commit
209
+
2.**Scans commits** between the commit from the last release and the current commit
209
210
3.**Extracts issue identifiers** from branch names and commit messages (e.g., `feat/ENG-123-add-feature`)
5.**Syncs to Linear**creating or updating the release with linked issues
212
+
5.**Syncs data to Linear**that adds issues to a newly created completed release (continuous pipelines) or the currently in-progress release (scheduled pipelines)
0 commit comments