Skip to content

Documentation improvements #8

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
RomainCscn merged 1 commit into from
Feb 23, 2026
Merged

Documentation improvements #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ steps:
| --------------- | -------- | -------- | -------------------------------------------------------------------------- |
| `access_key` | Yes | | Linear pipeline access key for authentication |
| `command` | No | `sync` | Command to run: `sync`, `complete`, or `update` |
| `name` | No | | Custom release name (only used with `sync` command) |
| `name` | No | | Custom release name for `sync`. Continuous pipelines: used on create. Scheduled pipelines: used only when `sync` creates a release; existing release names are preserved. Ignored (with warning) for `complete` and `update`. |
| `version` | No | | Release version identifier |
| `stage` | No | | Deployment stage such as `staging` or `production` (required for `update`) |
| `include_paths` | No | | Filter commits by file paths (comma-separated globs for monorepos) |
Expand Down Expand Up @@ -119,6 +119,16 @@ Updates the deployment stage of the current release. Only applicable to schedule
stage: staging
```

### Command targeting

| Command | With `version` | Without `version` |
| ------- | -------------- | ----------------- |
| `sync` | Targets matching version or creates that version | Continuous pipelines create a release with short SHA name/version. Scheduled pipelines use current started/planned flow. |
| `update` | Updates that exact release version | Updates latest started release, or latest planned release if no started release exists |
| `complete` | Completes that exact release version | Completes latest started release |

For scheduled pipelines, prefer always passing `version` in CI, especially when releases overlap.

### Monorepo filtering

Filter commits by file paths to track releases for specific packages:
Expand All @@ -144,6 +154,10 @@ Ensure you've set the `access_key` input with your Linear pipeline access key st

Make sure your commits contain Linear issue identifiers (e.g., `ENG-123`) and that `actions/checkout` uses `fetch-depth: 0`.

**`name` is ignored on non-sync commands**

If `name` is provided with `command: update` or `command: complete`, the action prints a warning and continues. Use `name` with `command: sync` only.

## License

MIT - see [LICENSE](LICENSE)
4 changes: 4 additions & 0 deletions run.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ if [[ "$COMMAND" == "update" && -z "${INPUT_STAGE:-}" ]]; then
exit 1
fi

if [[ "$COMMAND" != "sync" && -n "${INPUT_NAME:-}" ]]; then
echo "::warning::name input is ignored when command is '$COMMAND' (only used with 'sync')"
fi

args=()
[[ -n "${INPUT_NAME:-}" ]] && args+=("--name=${INPUT_NAME}")
[[ -n "${INPUT_VERSION:-}" ]] && args+=("--release-version=${INPUT_VERSION}")
Expand Down