Skip to content

Commit 0da9132

Browse files
Tweak README (#23)
* Tweak README * Address feedback
1 parent e1540df commit 0da9132

1 file changed

Lines changed: 9 additions & 8 deletions

File tree

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,21 @@
2323
2424
## Overview
2525

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:
2727

2828
- Scans commits for Linear issue identifiers (e.g., `ENG-123`)
2929
- Detects pull request references in commit messages
3030
- 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
3233

3334
## Pipeline Types
3435

35-
Linear Release supports two pipeline styles, configured in Linear:
36+
Linear Release supports two pipeline styles, created and configured in Linear:
3637

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.
3839

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).
4041

4142
## Installation
4243

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

189190
### Path Filtering
190191

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.
192193

193194
```bash
194195
# 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
205206
## How It Works
206207

207208
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
209210
3. **Extracts issue identifiers** from branch names and commit messages (e.g., `feat/ENG-123-add-feature`)
210211
4. **Detects pull request numbers** from commit messages (e.g., `Merge pull request #42`)
211-
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)
212213

213214
## Troubleshooting
214215

0 commit comments

Comments
 (0)