Skip to content

Commit 0a26d7a

Browse files
octocatbitwizeshift
octocat
and
bitwizeshift
committed
📄 Update generated documentation
This commits the output of the `generate-docs` tool. Source-commit: ec11bbe Github-workflow-id: 7350724389 Github-workflow: https://github.com/bitwizeshift/actions-github/actions/runs/7350724389 Co-authored-by: Matthew Rodusek <[email protected]>
1 parent ec11bbe commit 0a26d7a

24 files changed

+145
-97
lines changed

‎docs/issues-add-assignees.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,12 @@ This requires `issues: write` permissions in order to work correctly.
1010
| Name | Description | Default |
1111
|------|-------------|---------|
1212
| `assignees` (*) | A list of labels to add, separated by newlines. | _N/A_ |
13+
| `github-token` | The default token to use for this Git operation. If unspecified, this will default to `github.token`. | `"${{ github.token }}"` |
1314
| `issue-number` | The issue number to comment on | `"0"` |
14-
| `owner` | The repository owner | `""` |
15-
| `repo` | The repository | `""` |
16-
| `retries` | The number of times to try retrying | `"0"` |
17-
| `retry-exempt-status-codes` | The retry exempt status codes | `"400,401,403,404,422"` |
15+
| `owner` | The repository owner. If unspecified, this will default to the owner of the current repository. | `""` |
16+
| `repo` | The name of the repository. If unspecified, this will default to the current repository. | `""` |
17+
| `retries` | The number of times to attempt to retry if this fails. | `"0"` |
18+
| `retry-exempt-status-codes` | A list of error-codes that are exempt from being retried. | `"400,401,403,404,422"` |
1819

1920
**Note:** _(*) marks required inputs_
2021

@@ -40,6 +41,7 @@ run:
4041
assignees: ASSIGNEES
4142

4243
# Optional inputs
44+
github-token: GITHUB_TOKEN
4345
issue-number: ISSUE_NUMBER
4446
owner: OWNER
4547
repo: REPO

‎docs/issues-add-labels.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,12 @@ This requires `issues: write` permissions in order to work correctly.
1010
| Name | Description | Default |
1111
|------|-------------|---------|
1212
| `labels` (*) | A list of labels to add, separated by newlines. | _N/A_ |
13+
| `github-token` | The default token to use for this Git operation. If unspecified, this will default to `github.token`. | `"${{ github.token }}"` |
1314
| `issue-number` | The issue number to comment on | `"0"` |
14-
| `owner` | The repository owner | `""` |
15-
| `repo` | The repository | `""` |
16-
| `retries` | The number of times to try retrying | `"0"` |
17-
| `retry-exempt-status-codes` | The retry exempt status codes | `"400,401,403,404,422"` |
15+
| `owner` | The repository owner. If unspecified, this will default to the owner of the current repository. | `""` |
16+
| `repo` | The name of the repository. If unspecified, this will default to the current repository. | `""` |
17+
| `retries` | The number of times to attempt to retry if this fails. | `"0"` |
18+
| `retry-exempt-status-codes` | A list of error-codes that are exempt from being retried. | `"400,401,403,404,422"` |
1819

1920
**Note:** _(*) marks required inputs_
2021

@@ -40,6 +41,7 @@ run:
4041
labels: LABELS
4142

4243
# Optional inputs
44+
github-token: GITHUB_TOKEN
4345
issue-number: ISSUE_NUMBER
4446
owner: OWNER
4547
repo: REPO

‎docs/issues-close.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,12 @@ This requires `issues: write` permissions in order to work correctly.
99

1010
| Name | Description | Default |
1111
|------|-------------|---------|
12+
| `github-token` | The default token to use for this Git operation. If unspecified, this will default to `github.token`. | `"${{ github.token }}"` |
1213
| `issue-number` | The issue number to comment on | `"0"` |
13-
| `owner` | The repository owner | `""` |
14-
| `repo` | The repository | `""` |
15-
| `retries` | The number of times to try retrying | `"0"` |
16-
| `retry-exempt-status-codes` | The retry exempt status codes | `"400,401,403,404,422"` |
14+
| `owner` | The repository owner. If unspecified, this will default to the owner of the current repository. | `""` |
15+
| `repo` | The name of the repository. If unspecified, this will default to the current repository. | `""` |
16+
| `retries` | The number of times to attempt to retry if this fails. | `"0"` |
17+
| `retry-exempt-status-codes` | A list of error-codes that are exempt from being retried. | `"400,401,403,404,422"` |
1718
| `state_reason` | The reason for the state-change | `"completed"` |
1819

1920
## Outputs
@@ -35,6 +36,7 @@ run:
3536
uses: bitwizeshift/actions-github/issues/close@v1
3637
with:
3738
# Optional inputs
39+
github-token: GITHUB_TOKEN
3840
issue-number: ISSUE_NUMBER
3941
owner: OWNER
4042
repo: REPO

‎docs/issues-create-comment.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,12 @@ Requires the `issues: write` permission to work.
1010
| Name | Description | Default |
1111
|------|-------------|---------|
1212
| `body` (*) | The message to comment | _N/A_ |
13+
| `github-token` | The default token to use for this Git operation. If unspecified, this will default to `github.token`. | `"${{ github.token }}"` |
1314
| `issue-number` | The issue number to comment on | `"0"` |
14-
| `owner` | The repository owner | `""` |
15-
| `repo` | The repository | `""` |
16-
| `retries` | The number of times to try retrying | `"0"` |
17-
| `retry-exempt-status-codes` | The retry exempt status codes | `"400,401,403,404,422"` |
15+
| `owner` | The repository owner. If unspecified, this will default to the owner of the current repository. | `""` |
16+
| `repo` | The name of the repository. If unspecified, this will default to the current repository. | `""` |
17+
| `retries` | The number of times to attempt to retry if this fails. | `"0"` |
18+
| `retry-exempt-status-codes` | A list of error-codes that are exempt from being retried. | `"400,401,403,404,422"` |
1819

1920
**Note:** _(*) marks required inputs_
2021

@@ -45,6 +46,7 @@ run:
4546
body: BODY
4647

4748
# Optional inputs
49+
github-token: GITHUB_TOKEN
4850
issue-number: ISSUE_NUMBER
4951
owner: OWNER
5052
repo: REPO

‎docs/issues-create-or-comment.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,12 @@ This requires `issues: write` permissions in order to work correctly.
1414
| `assignees` | A list of assignees to add, separated by newlines. | `""` |
1515
| `body` | The body text of the github issue | `""` |
1616
| `comment` | The comment to leave if an issue already exists | `"${{ inputs.body }}"` |
17+
| `github-token` | The default token to use for this Git operation. If unspecified, this will default to `github.token`. | `"${{ github.token }}"` |
1718
| `labels` | A list of labels to add, separated by newlines. | `""` |
18-
| `owner` | The repository owner | `""` |
19-
| `repo` | The repository | `""` |
20-
| `retries` | The number of times to try retrying | `"3"` |
21-
| `retry-exempt-status-codes` | The retry exempt status codes | `"400,401,403,404,422"` |
19+
| `owner` | The repository owner. If unspecified, this will default to the owner of the current repository. | `""` |
20+
| `repo` | The name of the repository. If unspecified, this will default to the current repository. | `""` |
21+
| `retries` | The number of times to attempt to retry if this fails. | `"0"` |
22+
| `retry-exempt-status-codes` | A list of error-codes that are exempt from being retried. | `"400,401,403,404,422"` |
2223

2324
**Note:** _(*) marks required inputs_
2425

@@ -52,6 +53,7 @@ run:
5253
assignees: ASSIGNEES
5354
body: BODY
5455
comment: COMMENT
56+
github-token: GITHUB_TOKEN
5557
labels: LABELS
5658
owner: OWNER
5759
repo: REPO

‎docs/issues-create.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,12 @@ This requires `issues: write` permissions in order to work correctly.
1212
| `title` (*) | The title to use for the issue | _N/A_ |
1313
| `assignees` | A list of assignees to add, separated by newlines. | `""` |
1414
| `body` | The body text of the github issue | `""` |
15+
| `github-token` | The default token to use for this Git operation. If unspecified, this will default to `github.token`. | `"${{ github.token }}"` |
1516
| `labels` | A list of labels to add, separated by newlines. | `""` |
16-
| `owner` | The repository owner | `""` |
17-
| `repo` | The repository | `""` |
18-
| `retries` | The number of times to try retrying | `"3"` |
19-
| `retry-exempt-status-codes` | The retry exempt status codes | `"400,401,403,404,422"` |
17+
| `owner` | The repository owner. If unspecified, this will default to the owner of the current repository. | `""` |
18+
| `repo` | The name of the repository. If unspecified, this will default to the current repository. | `""` |
19+
| `retries` | The number of times to attempt to retry if this fails. | `"0"` |
20+
| `retry-exempt-status-codes` | A list of error-codes that are exempt from being retried. | `"400,401,403,404,422"` |
2021

2122
**Note:** _(*) marks required inputs_
2223

@@ -48,6 +49,7 @@ run:
4849
# Optional inputs
4950
assignees: ASSIGNEES
5051
body: BODY
52+
github-token: GITHUB_TOKEN
5153
labels: LABELS
5254
owner: OWNER
5355
repo: REPO

‎docs/issues-delete-comment.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,11 @@ This requires `issues: write` permissions in order to work correctly.
1010
| Name | Description | Default |
1111
|------|-------------|---------|
1212
| `comment-id` (*) | The comment to delete | _N/A_ |
13-
| `owner` | The repository owner | `""` |
14-
| `repo` | The repository | `""` |
15-
| `retries` | The number of times to try retrying | `"0"` |
16-
| `retry-exempt-status-codes` | The retry exempt status codes | `"400,401,403,404,422"` |
13+
| `github-token` | The default token to use for this Git operation. If unspecified, this will default to `github.token`. | `"${{ github.token }}"` |
14+
| `owner` | The repository owner. If unspecified, this will default to the owner of the current repository. | `""` |
15+
| `repo` | The name of the repository. If unspecified, this will default to the current repository. | `""` |
16+
| `retries` | The number of times to attempt to retry if this fails. | `"0"` |
17+
| `retry-exempt-status-codes` | A list of error-codes that are exempt from being retried. | `"400,401,403,404,422"` |
1718

1819
**Note:** _(*) marks required inputs_
1920

@@ -39,6 +40,7 @@ run:
3940
comment-id: COMMENT_ID
4041

4142
# Optional inputs
43+
github-token: GITHUB_TOKEN
4244
owner: OWNER
4345
repo: REPO
4446
retries: RETRIES

‎docs/issues-get.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,12 @@ This requires `issues: write` permissions in order to work correctly.
99

1010
| Name | Description | Default |
1111
|------|-------------|---------|
12+
| `github-token` | The default token to use for this Git operation. If unspecified, this will default to `github.token`. | `"${{ github.token }}"` |
1213
| `issue-number` | The issue number to comment on | `"0"` |
13-
| `owner` | The repository owner | `""` |
14-
| `repo` | The repository | `""` |
15-
| `retries` | The number of times to try retrying | `"3"` |
16-
| `retry-exempt-status-codes` | The retry exempt status codes | `"400,401,403,404,422"` |
14+
| `owner` | The repository owner. If unspecified, this will default to the owner of the current repository. | `""` |
15+
| `repo` | The name of the repository. If unspecified, this will default to the current repository. | `""` |
16+
| `retries` | The number of times to attempt to retry if this fails. | `"0"` |
17+
| `retry-exempt-status-codes` | A list of error-codes that are exempt from being retried. | `"400,401,403,404,422"` |
1718

1819
## Outputs
1920

@@ -48,6 +49,7 @@ run:
4849
uses: bitwizeshift/actions-github/issues/get@v1
4950
with:
5051
# Optional inputs
52+
github-token: GITHUB_TOKEN
5153
issue-number: ISSUE_NUMBER
5254
owner: OWNER
5355
repo: REPO

‎docs/issues-lock.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,13 @@ This requires `issues: write` permissions in order to work correctly.
99

1010
| Name | Description | Default |
1111
|------|-------------|---------|
12+
| `github-token` | The default token to use for this Git operation. If unspecified, this will default to `github.token`. | `"${{ github.token }}"` |
1213
| `issue-number` | The issue number to comment on | `"0"` |
13-
| `lock-reason` | The reason the issue is being locked. Must be one of: * off-topic * too heated * resolved * spam | `"resolved"` |
14-
| `owner` | The repository owner | `""` |
15-
| `repo` | The repository | `""` |
16-
| `retries` | The number of times to try retrying | `"0"` |
17-
| `retry-exempt-status-codes` | The retry exempt status codes | `"400,401,403,404,422"` |
14+
| `lock-reason` | The reason the issue is being locked. Must be one of: "off-topic", "too heated", "resolved", "spam" | `"resolved"` |
15+
| `owner` | The repository owner. If unspecified, this will default to the owner of the current repository. | `""` |
16+
| `repo` | The name of the repository. If unspecified, this will default to the current repository. | `""` |
17+
| `retries` | The number of times to attempt to retry if this fails. | `"0"` |
18+
| `retry-exempt-status-codes` | A list of error-codes that are exempt from being retried. | `"400,401,403,404,422"` |
1819

1920
## Outputs
2021

@@ -35,6 +36,7 @@ run:
3536
uses: bitwizeshift/actions-github/issues/lock@v1
3637
with:
3738
# Optional inputs
39+
github-token: GITHUB_TOKEN
3840
issue-number: ISSUE_NUMBER
3941
lock-reason: LOCK_REASON
4042
owner: OWNER

‎docs/issues-remove-assignees.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,12 @@ This requires `issues: write` permissions in order to work correctly.
1010
| Name | Description | Default |
1111
|------|-------------|---------|
1212
| `assignees` (*) | A list of assignees to remove, separated by either newlines or commas. | _N/A_ |
13+
| `github-token` | The default token to use for this Git operation. If unspecified, this will default to `github.token`. | `"${{ github.token }}"` |
1314
| `issue-number` | The issue number to comment on | `"0"` |
14-
| `owner` | The repository owner | `""` |
15-
| `repo` | The repository | `""` |
16-
| `retries` | The number of times to try retrying | `"0"` |
17-
| `retry-exempt-status-codes` | The retry exempt status codes | `"400,401,403,404,422"` |
15+
| `owner` | The repository owner. If unspecified, this will default to the owner of the current repository. | `""` |
16+
| `repo` | The name of the repository. If unspecified, this will default to the current repository. | `""` |
17+
| `retries` | The number of times to attempt to retry if this fails. | `"0"` |
18+
| `retry-exempt-status-codes` | A list of error-codes that are exempt from being retried. | `"400,401,403,404,422"` |
1819

1920
**Note:** _(*) marks required inputs_
2021

@@ -40,6 +41,7 @@ run:
4041
assignees: ASSIGNEES
4142

4243
# Optional inputs
44+
github-token: GITHUB_TOKEN
4345
issue-number: ISSUE_NUMBER
4446
owner: OWNER
4547
repo: REPO

0 commit comments

Comments
 (0)