Skip to content

Commit c2bdb69

Browse files
authored
Proper inputs for GH action in skills and examples (#17)
1 parent 33c8418 commit c2bdb69

2 files changed

Lines changed: 20 additions & 8 deletions

File tree

examples/github-actions-scheduled.yml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ on:
2222
- "release/**"
2323
workflow_dispatch:
2424
inputs:
25-
action:
26-
description: "Release action"
25+
command:
26+
description: "Release command"
2727
required: true
2828
type: choice
2929
options:
@@ -33,7 +33,7 @@ on:
3333
description: "Release stage (for update, e.g. qa)"
3434
required: false
3535
type: string
36-
release_version:
36+
version:
3737
description: "Release version"
3838
required: true
3939
type: string
@@ -62,22 +62,22 @@ jobs:
6262
if: github.event_name == 'push' && startsWith(github.ref_name, 'release/')
6363
with:
6464
access_key: ${{ secrets.LINEAR_ACCESS_KEY }}
65-
release_version: ${{ env.RELEASE_VERSION }}
65+
version: ${{ env.RELEASE_VERSION }}
6666

6767
# Branch creation: auto-promote to code freeze
6868
- uses: linear/linear-release-action@v0
6969
if: github.event_name == 'push' && startsWith(github.ref_name, 'release/') && github.event.created
7070
with:
7171
access_key: ${{ secrets.LINEAR_ACCESS_KEY }}
72-
action: update
72+
command: update
7373
stage: code freeze
74-
release_version: ${{ env.RELEASE_VERSION }}
74+
version: ${{ env.RELEASE_VERSION }}
7575

7676
# Manual: run the specified action (later stages, completion)
7777
- uses: linear/linear-release-action@v0
7878
if: github.event_name == 'workflow_dispatch'
7979
with:
8080
access_key: ${{ secrets.LINEAR_ACCESS_KEY }}
81-
action: ${{ inputs.action }}
81+
command: ${{ inputs.command }}
8282
stage: ${{ inputs.stage }}
83-
release_version: ${{ inputs.release_version }}
83+
version: ${{ inputs.version }}

skills/linear-release-setup/SKILL.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,18 @@ Stages can be **frozen** in Linear. A frozen stage makes `sync` (without `--rele
9696
| `update` | Move release to a stage | `--stage` (required), `--release-version` |
9797
| `complete` | Mark release as complete | `--release-version` |
9898

99+
### GitHub Action Inputs
100+
101+
When using `linear/linear-release-action@v0`, inputs map to CLI flags as follows:
102+
103+
| CLI flag | Action input |
104+
| -------------------- | ------------------------------------ |
105+
| (command positional) | `command` |
106+
| `--name` | `name` |
107+
| `--release-version` | `version` (alias: `release_version`) |
108+
| `--stage` | `stage` |
109+
| `--include-paths` | `include_paths` |
110+
99111
### Path Filtering (Monorepos)
100112

101113
Path filters can be configured in Linear's pipeline settings or via the CLI's `--include-paths` flag (CLI takes precedence if both are set). If the user has already configured paths in Linear, the CLI flag is optional.

0 commit comments

Comments
 (0)