Skip to content

Tweak README #11

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 1 commit into from
Mar 3, 2026
Merged

Tweak README #11

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
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,15 @@
<a href="https://github.com/linear/linear-release-action/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="Linear Release Action is released under the MIT license."></a>
</p>

> [!NOTE]
> This project is currently in beta and requires enrollment to use. If you're interested in trying it out or need assistance, please contact [Linear support](https://linear.app/contact) or your account manager. APIs and commands may change in future releases.
> [!IMPORTANT]
> Linear Release is in **closed beta**. Contact [Linear support](https://linear.app/contact) or your account manager to request access. APIs and commands may change.

## Overview

This action wraps the [Linear Release CLI](https://github.com/linear/linear-release) to integrate your CI/CD pipeline with [Linear's release management](https://linear.app/docs/releases). It automatically scans commits for Linear issue identifiers, detects pull request references, and creates or updates releases in Linear.

For full documentation on pipeline types, how commit scanning works, path filtering details, and troubleshooting, see the [Linear Release CLI README](https://github.com/linear/linear-release#readme). This README covers the GitHub Action-specific configuration.

## Quick Start

```yaml
Expand Down Expand Up @@ -130,9 +132,9 @@ Updates the deployment stage of the current release. Only applicable to schedule

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

### Monorepo filtering
### Path filtering

Filter commits by file paths to track releases for specific packages:
Filter commits by file paths to track releases for specific packages, useful for monorepos:

```yaml
- uses: linear/linear-release-action@v0
Expand Down