Skip to content

Commit 2e42c55

Browse files
octocatoctocat
committed
📄 Update generated documentation
This commits the output of the `generate-docs` tool. Source-commit: 0a33f30 Workflow-run-id: 7350556563
1 parent 0a33f30 commit 2e42c55

11 files changed

+412
-2
lines changed

‎README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,16 @@ Below are the list of available actions, with links to documentation:
2424
* [`issues/remove-label`](docs/issues-remove-label.md)
2525
* [`issues/set-labels`](docs/issues-set-labels.md)
2626
* [`issues/unlock`](docs/issues-unlock.md)
27+
* [`issues/update`](docs/issues-update.md)
2728
* [`issues/update-comment`](docs/issues-update-comment.md)
29+
* [`pulls/add-assignees`](docs/pulls-add-assignees.md)
30+
* [`pulls/add-labels`](docs/pulls-add-labels.md)
31+
* [`pulls/close`](docs/pulls-close.md)
32+
* [`pulls/create-comment`](docs/pulls-create-comment.md)
33+
* [`pulls/get`](docs/pulls-get.md)
2834
* [`releases/create`](docs/releases-create.md)
2935
* [`releases/delete`](docs/releases-delete.md)
36+
* [`releases/delete-asset`](docs/releases-delete-asset.md)
3037
* [`releases/upload-asset`](docs/releases-upload-asset.md)
3138

3239
## License

‎docs/issues-create-comment.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,9 @@ Requires the `issues: write` permission to work.
2222

2323
| Name | Description |
2424
|------|-------------|
25+
| `comment-api-url` | An API URL to the created comment |
2526
| `comment-id` | The ID of the created comment |
26-
| `comment-url` | A URL to the created comment |
27+
| `comment-url` | A browser URL to the created comment |
2728

2829
## Example
2930

@@ -53,6 +54,7 @@ run:
5354
- name: Uses "Create comment on Issue" Outputs
5455
uses: example-actions/use-issues-create-comment@v3 # illustrative
5556
with:
57+
use-comment-api-url: ${{ steps.issues-create-comment.outputs.comment-api-url }}
5658
use-comment-id: ${{ steps.issues-create-comment.outputs.comment-id }}
5759
use-comment-url: ${{ steps.issues-create-comment.outputs.comment-url }}
5860
```

‎docs/issues-get.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,13 @@ This requires `issues: write` permissions in order to work correctly.
2020
| Name | Description |
2121
|------|-------------|
2222
| `assignees` | A JSON array of all the assignee logins for this issue. |
23+
| `assignees-count` | The number of assignees to this issue. |
2324
| `body` | The body description of the issue |
2425
| `issue-api-url` | The API URL corresponding to this issue. |
2526
| `issue-number` | The number of the issue that was retrieved. |
2627
| `issue-url` | The browser URL corresponding to this issue. |
2728
| `labels` | A JSON array of all the label names for this issue. |
29+
| `labels-count` | The number of labels assigned to this issue. |
2830
| `locked` | Whether this issue is currently locked |
2931
| `state` | The state of the issue |
3032
| `state-reason` | The reason for the state |
@@ -56,11 +58,13 @@ run:
5658
uses: example-actions/use-issues-get@v3 # illustrative
5759
with:
5860
use-assignees: ${{ steps.issues-get.outputs.assignees }}
61+
use-assignees-count: ${{ steps.issues-get.outputs.assignees-count }}
5962
use-body: ${{ steps.issues-get.outputs.body }}
6063
use-issue-api-url: ${{ steps.issues-get.outputs.issue-api-url }}
6164
use-issue-number: ${{ steps.issues-get.outputs.issue-number }}
6265
use-issue-url: ${{ steps.issues-get.outputs.issue-url }}
6366
use-labels: ${{ steps.issues-get.outputs.labels }}
67+
use-labels-count: ${{ steps.issues-get.outputs.labels-count }}
6468
use-locked: ${{ steps.issues-get.outputs.locked }}
6569
use-state: ${{ steps.issues-get.outputs.state }}
6670
use-state-reason: ${{ steps.issues-get.outputs.state-reason }}

‎docs/issues-update.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Update issue
2+
3+
<!-- These docs are generated by a tool -->
4+
5+
A composite action for updating an existing github issue.
6+
This action will update _all_ fields of the issue, and thus should be used
7+
sparingly. Consider using the `issues/add-*` or `issues/remove-*` series of
8+
steps to alter the issue in-place.
9+
This requires `issues: write` permissions in order to work correctly.
10+
11+
## Inputs
12+
13+
| Name | Description | Default |
14+
|------|-------------|---------|
15+
| `title` (*) | The title to use for the issue | _N/A_ |
16+
| `assignees` | A list of assignees to add, separated by newlines. | `""` |
17+
| `body` | The body text of the github issue | `""` |
18+
| `issue-number` | The issue number to comment on. If not specified, this will attempt to retrieve the issue number from the Github `context` variable. | `"0"` |
19+
| `labels` | A list of labels to add, separated by newlines. | `""` |
20+
| `owner` | The repository owner | `""` |
21+
| `repo` | The repository | `""` |
22+
| `retries` | The number of times to try retrying | `"3"` |
23+
| `retry-exempt-status-codes` | The retry exempt status codes | `"400,401,403,404,422"` |
24+
25+
**Note:** _(*) marks required inputs_
26+
27+
## Outputs
28+
29+
| Name | Description |
30+
|------|-------------|
31+
| `issue-number` | The number of the created issue |
32+
| `issue-url` | The HTTP URL of the newly created issue |
33+
34+
## Example
35+
36+
Here is a very basic example of how to use the `issues/update` composite action
37+
in a project (placeholders are used in place of real inputs):
38+
39+
```yaml
40+
run:
41+
example-job:
42+
# ...
43+
steps:
44+
# ...
45+
- name: Update issue
46+
id: issues-update # only necessary if using this action's output(s)
47+
uses: bitwizeshift/actions-github/issues/update@v1
48+
with:
49+
# Required inputs
50+
title: TITLE
51+
52+
# Optional inputs
53+
assignees: ASSIGNEES
54+
body: BODY
55+
issue-number: ISSUE_NUMBER
56+
labels: LABELS
57+
owner: OWNER
58+
repo: REPO
59+
retries: RETRIES
60+
retry-exempt-status-codes: RETRY_EXEMPT_STATUS_CODES
61+
# ...
62+
- name: Uses "Update issue" Outputs
63+
uses: example-actions/use-issues-update@v3 # illustrative
64+
with:
65+
use-issue-number: ${{ steps.issues-update.outputs.issue-number }}
66+
use-issue-url: ${{ steps.issues-update.outputs.issue-url }}
67+
```

‎docs/pulls-add-assignees.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Add assignees to Pull Request
2+
3+
<!-- These docs are generated by a tool -->
4+
5+
A composite action for adding assignees to github pull requests.
6+
This requires `pull-requests: write` permissions in order to work correctly.
7+
8+
## Inputs
9+
10+
| Name | Description | Default |
11+
|------|-------------|---------|
12+
| `labels` (*) | A list of labels to add, separated by newlines. | _N/A_ |
13+
| `owner` | The repository owner | `""` |
14+
| `pull-number` | The pull request number to update | `"0"` |
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"` |
18+
19+
**Note:** _(*) marks required inputs_
20+
21+
## Outputs
22+
23+
`pulls/add-assignees` does not have any outputs at this time
24+
25+
## Example
26+
27+
Here is a very basic example of how to use the `pulls/add-assignees` composite action
28+
in a project (placeholders are used in place of real inputs):
29+
30+
```yaml
31+
run:
32+
example-job:
33+
# ...
34+
steps:
35+
# ...
36+
- name: Add assignees to Pull Request
37+
uses: bitwizeshift/actions-github/pulls/add-assignees@v1
38+
with:
39+
# Required inputs
40+
labels: LABELS
41+
42+
# Optional inputs
43+
owner: OWNER
44+
pull-number: PULL_NUMBER
45+
repo: REPO
46+
retries: RETRIES
47+
retry-exempt-status-codes: RETRY_EXEMPT_STATUS_CODES
48+
```

‎docs/pulls-add-labels.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Add labels to Pull Request
2+
3+
<!-- These docs are generated by a tool -->
4+
5+
A composite action for adding labels to github pull requests.
6+
This requires `pull-requests: write` permissions in order to work correctly.
7+
8+
## Inputs
9+
10+
| Name | Description | Default |
11+
|------|-------------|---------|
12+
| `labels` (*) | A list of labels to add, separated by newlines. | _N/A_ |
13+
| `owner` | The repository owner | `""` |
14+
| `pull-number` | The pull request number to update | `"0"` |
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"` |
18+
19+
**Note:** _(*) marks required inputs_
20+
21+
## Outputs
22+
23+
`pulls/add-labels` does not have any outputs at this time
24+
25+
## Example
26+
27+
Here is a very basic example of how to use the `pulls/add-labels` composite action
28+
in a project (placeholders are used in place of real inputs):
29+
30+
```yaml
31+
run:
32+
example-job:
33+
# ...
34+
steps:
35+
# ...
36+
- name: Add labels to Pull Request
37+
uses: bitwizeshift/actions-github/pulls/add-labels@v1
38+
with:
39+
# Required inputs
40+
labels: LABELS
41+
42+
# Optional inputs
43+
owner: OWNER
44+
pull-number: PULL_NUMBER
45+
repo: REPO
46+
retries: RETRIES
47+
retry-exempt-status-codes: RETRY_EXEMPT_STATUS_CODES
48+
```

‎docs/pulls-close.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Close pull request
2+
3+
<!-- These docs are generated by a tool -->
4+
5+
A composite action for closing a pull request.
6+
This requires `pulls: write` permissions in order to work correctly.
7+
8+
## Inputs
9+
10+
| Name | Description | Default |
11+
|------|-------------|---------|
12+
| `owner` | The repository owner | `""` |
13+
| `pull-number` | The pull request number to comment on | `"0"` |
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"` |
17+
18+
## Outputs
19+
20+
| Name | Description |
21+
|------|-------------|
22+
| `pull-number` | The pull request number that was closed |
23+
24+
## Example
25+
26+
Here is a very basic example of how to use the `pulls/close` composite action
27+
in a project (placeholders are used in place of real inputs):
28+
29+
```yaml
30+
run:
31+
example-job:
32+
# ...
33+
steps:
34+
# ...
35+
- name: Close pull request
36+
id: pulls-close # only necessary if using this action's output
37+
uses: bitwizeshift/actions-github/pulls/close@v1
38+
with:
39+
# Optional inputs
40+
owner: OWNER
41+
pull-number: PULL_NUMBER
42+
repo: REPO
43+
retries: RETRIES
44+
retry-exempt-status-codes: RETRY_EXEMPT_STATUS_CODES
45+
# ...
46+
- name: Uses "Close pull request" Outputs
47+
uses: example-actions/use-pulls-close@v3 # illustrative
48+
with:
49+
use-pull-number: ${{ steps.pulls-close.outputs.pull-number }}
50+
```

‎docs/pulls-create-comment.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Create comment on Pull Request
2+
3+
<!-- These docs are generated by a tool -->
4+
5+
A composite action that creates a comment on a pull-request.
6+
Requires the `pull-requests: write` permission to work.
7+
8+
## Inputs
9+
10+
| Name | Description | Default |
11+
|------|-------------|---------|
12+
| `body` (*) | The message to comment | _N/A_ |
13+
| `owner` | The repository owner | `""` |
14+
| `pull-number` | The pull-request number to comment on. | `"0"` |
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"` |
18+
19+
**Note:** _(*) marks required inputs_
20+
21+
## Outputs
22+
23+
| Name | Description |
24+
|------|-------------|
25+
| `comment-api-url` | An API URL to the created comment |
26+
| `comment-id` | The ID of the created comment |
27+
| `comment-url` | A browser URL to the created comment |
28+
29+
## Example
30+
31+
Here is a very basic example of how to use the `pulls/create-comment` composite action
32+
in a project (placeholders are used in place of real inputs):
33+
34+
```yaml
35+
run:
36+
example-job:
37+
# ...
38+
steps:
39+
# ...
40+
- name: Create comment on Pull Request
41+
id: pulls-create-comment # only necessary if using this action's output(s)
42+
uses: bitwizeshift/actions-github/pulls/create-comment@v1
43+
with:
44+
# Required inputs
45+
body: BODY
46+
47+
# Optional inputs
48+
owner: OWNER
49+
pull-number: PULL_NUMBER
50+
repo: REPO
51+
retries: RETRIES
52+
retry-exempt-status-codes: RETRY_EXEMPT_STATUS_CODES
53+
# ...
54+
- name: Uses "Create comment on Pull Request" Outputs
55+
uses: example-actions/use-pulls-create-comment@v3 # illustrative
56+
with:
57+
use-comment-api-url: ${{ steps.pulls-create-comment.outputs.comment-api-url }}
58+
use-comment-id: ${{ steps.pulls-create-comment.outputs.comment-id }}
59+
use-comment-url: ${{ steps.pulls-create-comment.outputs.comment-url }}
60+
```

0 commit comments

Comments
 (0)