Skip to content

Commit d92e8c6

Browse files
Piotr1215Piotr1215
committed
docs(link-backport-prs): explain why linear-token is optional
A reviewer read the optional linear-token as an oversight and expected it to be required. It is optional on purpose: the linking step is advisory and no-ops when the token is absent so callers can adopt the shared backport workflow before wiring up a Linear token. Spell that out in the input description so the next reader does not have to ask.
1 parent 74dcd6a commit d92e8c6

2 files changed

Lines changed: 10 additions & 10 deletions

File tree

‎.github/actions/link-backport-prs/README.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,15 @@ The `github-token` must be the same PAT that created the backport PRs (a PAT, no
4545

4646
<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
4747

48-
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
49-
|--------------|--------|----------|------------------|-----------------------------------------------------------------------------------------------------------------------|
50-
| dry-run | string | false | `"false"` | Log intended edits without applying them |
51-
| github-token | string | true | | GitHub token with permission to read <br>and edit pull requests (must be the same PAT that created the backport PRs) |
52-
| label-prefix | string | false | `"backport-to-"` | Prefix of the backport labels on <br>the source PR |
53-
| linear-token | string | false | | Linear API token for resolving the <br>issue family. If empty, the action <br>no-ops. |
54-
| repo-name | string | true | | The name of the repository |
55-
| repo-owner | string | true | | The owner of the repository |
56-
| source-pr | string | true | | The merged source pull request number <br>that was backported |
48+
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
49+
|--------------|--------|----------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
50+
| dry-run | string | false | `"false"` | Log intended edits without applying them |
51+
| github-token | string | true | | GitHub token with permission to read <br>and edit pull requests (must be the same PAT that created the backport PRs) |
52+
| label-prefix | string | false | `"backport-to-"` | Prefix of the backport labels on <br>the source PR |
53+
| linear-token | string | false | | Linear API token for resolving the <br>issue family. Optional by design: this <br>is an advisory step, so when <br>empty the action no-ops and exits <br>0 instead of failing, letting callers <br>adopt the shared backport workflow before <br>a Linear token is wired up. |
54+
| repo-name | string | true | | The name of the repository |
55+
| repo-owner | string | true | | The owner of the repository |
56+
| source-pr | string | true | | The merged source pull request number <br>that was backported |
5757

5858
<!-- AUTO-DOC-INPUT:END -->
5959

‎.github/actions/link-backport-prs/action.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ inputs:
1515
description: 'GitHub token with permission to read and edit pull requests (must be the same PAT that created the backport PRs)'
1616
required: true
1717
linear-token:
18-
description: 'Linear API token for resolving the issue family. If empty, the action no-ops.'
18+
description: 'Linear API token for resolving the issue family. Optional by design: this is an advisory step, so when empty the action no-ops and exits 0 instead of failing, letting callers adopt the shared backport workflow before a Linear token is wired up.'
1919
required: false
2020
default: ''
2121
label-prefix:

0 commit comments

Comments
 (0)