Skip to content

Commit c2fcbd8

Browse files
octocatoctocat
committed
📄 Update generated documentation
This commits the output of the `generate-docs` tool. Source-commit: 9154bb3 Workflow-run-id: 7350472864
1 parent 9154bb3 commit c2fcbd8

12 files changed

+182
-42
lines changed

‎README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ repository in [Github workflows]. All actions wrap the [octokit api] via
88

99
Below are the list of available actions, with links to documentation:
1010

11+
* [`git/add`](docs/git-add.md)
12+
* [`git/commit`](docs/git-commit.md)
13+
* [`git/push`](docs/git-push.md)
1114
* [`issues/add-assignees`](docs/issues-add-assignees.md)
1215
* [`issues/add-labels`](docs/issues-add-labels.md)
1316
* [`issues/close`](docs/issues-close.md)

‎docs/git-add.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Adds content to the git stage
2+
3+
<!-- These docs are generated by a tool -->
4+
5+
A composite action for adding content to the git stage.
6+
7+
## Inputs
8+
9+
| Name | Description | Default |
10+
|------|-------------|---------|
11+
| `path` | The path or paths to the content to add | `"."` |
12+
13+
## Outputs
14+
15+
| Name | Description |
16+
|------|-------------|
17+
| `staged` | `true` if any output was staged; `false` otherwise |
18+
19+
## Example
20+
21+
Here is a very basic example of how to use the `git/add` composite action
22+
in a project (placeholders are used in place of real inputs):
23+
24+
```yaml
25+
run:
26+
example-job:
27+
# ...
28+
steps:
29+
# ...
30+
- name: Adds content to the git stage
31+
id: git-add # only necessary if using this action's output
32+
uses: bitwizeshift/actions-github/git/add@v1
33+
with:
34+
# Optional inputs
35+
path: PATH
36+
# ...
37+
- name: Uses "Adds content to the git stage" Outputs
38+
uses: example-actions/use-git-add@v3 # illustrative
39+
with:
40+
use-staged: ${{ steps.git-add.outputs.staged }}
41+
```

‎docs/git-commit.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Create a git commit
2+
3+
<!-- These docs are generated by a tool -->
4+
5+
A composite action for committing the current staged content.
6+
7+
## Inputs
8+
9+
| Name | Description | Default |
10+
|------|-------------|---------|
11+
| `title` (*) | The title of the commit message | _N/A_ |
12+
| `body` | The body of the commit message | `""` |
13+
| `user-email` | The email of the user to commit as | `"[email protected]"` |
14+
| `user-name` | The default user to commit as | `"Octocat"` |
15+
16+
**Note:** _(*) marks required inputs_
17+
18+
## Outputs
19+
20+
| Name | Description |
21+
|------|-------------|
22+
| `sha1` | The SHA1 of the newly created commit |
23+
| `sha1-short` | The short/succinct SHA1 of the newly created commit |
24+
25+
## Example
26+
27+
Here is a very basic example of how to use the `git/commit` 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: Create a git commit
37+
id: git-commit # only necessary if using this action's output(s)
38+
uses: bitwizeshift/actions-github/git/commit@v1
39+
with:
40+
# Required inputs
41+
title: TITLE
42+
43+
# Optional inputs
44+
body: BODY
45+
user-email: USER_EMAIL
46+
user-name: USER_NAME
47+
# ...
48+
- name: Uses "Create a git commit" Outputs
49+
uses: example-actions/use-git-commit@v3 # illustrative
50+
with:
51+
use-sha1: ${{ steps.git-commit.outputs.sha1 }}
52+
use-sha1-short: ${{ steps.git-commit.outputs.sha1-short }}
53+
```

‎docs/git-push.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Push a git branch
2+
3+
<!-- These docs are generated by a tool -->
4+
5+
A composite action for pushing a git branch.
6+
7+
This requires `contents: write` permissions in order to work correctly.
8+
9+
## Inputs
10+
11+
| Name | Description | Default |
12+
|------|-------------|---------|
13+
| `branch` (*) | The name of the branch to push | _N/A_ |
14+
| `force` | Whether to force-push this branch | `"false"` |
15+
| `target-commitish` | The commit to push as the new branch | `"HEAD"` |
16+
17+
**Note:** _(*) marks required inputs_
18+
19+
## Outputs
20+
21+
`git/push` does not have any outputs at this time
22+
23+
## Example
24+
25+
Here is a very basic example of how to use the `git/push` composite action
26+
in a project (placeholders are used in place of real inputs):
27+
28+
```yaml
29+
run:
30+
example-job:
31+
# ...
32+
steps:
33+
# ...
34+
- name: Push a git branch
35+
uses: bitwizeshift/actions-github/git/push@v1
36+
with:
37+
# Required inputs
38+
branch: BRANCH
39+
40+
# Optional inputs
41+
force: FORCE
42+
target-commitish: TARGET_COMMITISH
43+
```

‎docs/issues-create-comment.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ run:
3737
steps:
3838
# ...
3939
- name: Create comment on Issue
40-
id: create-comment-on-issue # only necessary if using this action's output(s)
40+
id: issues-create-comment # only necessary if using this action's output(s)
4141
uses: bitwizeshift/actions-github/issues/create-comment@v1
4242
with:
4343
# Required inputs
@@ -51,8 +51,8 @@ run:
5151
retry-exempt-status-codes: RETRY_EXEMPT_STATUS_CODES
5252
# ...
5353
- name: Uses "Create comment on Issue" Outputs
54-
uses: example-actions/use-create-comment-on-issue@v3 # illustrative
54+
uses: example-actions/use-issues-create-comment@v3 # illustrative
5555
with:
56-
use-comment-id: ${{ steps.create-comment-on-issue.outputs.comment-id }}
57-
use-comment-url: ${{ steps.create-comment-on-issue.outputs.comment-url }}
56+
use-comment-id: ${{ steps.issues-create-comment.outputs.comment-id }}
57+
use-comment-url: ${{ steps.issues-create-comment.outputs.comment-url }}
5858
```

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ run:
4242
steps:
4343
# ...
4444
- name: Create issue or comment
45-
id: create-issue-or-comment # only necessary if using this action's output(s)
45+
id: issues-create-or-comment # only necessary if using this action's output(s)
4646
uses: bitwizeshift/actions-github/issues/create-or-comment@v1
4747
with:
4848
# Required inputs
@@ -59,9 +59,9 @@ run:
5959
retry-exempt-status-codes: RETRY_EXEMPT_STATUS_CODES
6060
# ...
6161
- name: Uses "Create issue or comment" Outputs
62-
uses: example-actions/use-create-issue-or-comment@v3 # illustrative
62+
uses: example-actions/use-issues-create-or-comment@v3 # illustrative
6363
with:
64-
use-created-issue: ${{ steps.create-issue-or-comment.outputs.created-issue }}
65-
use-issue-number: ${{ steps.create-issue-or-comment.outputs.issue-number }}
66-
use-issue-url: ${{ steps.create-issue-or-comment.outputs.issue-url }}
64+
use-created-issue: ${{ steps.issues-create-or-comment.outputs.created-issue }}
65+
use-issue-number: ${{ steps.issues-create-or-comment.outputs.issue-number }}
66+
use-issue-url: ${{ steps.issues-create-or-comment.outputs.issue-url }}
6767
```

‎docs/issues-create.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ run:
3939
steps:
4040
# ...
4141
- name: Create issue
42-
id: create-issue # only necessary if using this action's output(s)
42+
id: issues-create # only necessary if using this action's output(s)
4343
uses: bitwizeshift/actions-github/issues/create@v1
4444
with:
4545
# Required inputs
@@ -55,8 +55,8 @@ run:
5555
retry-exempt-status-codes: RETRY_EXEMPT_STATUS_CODES
5656
# ...
5757
- name: Uses "Create issue" Outputs
58-
uses: example-actions/use-create-issue@v3 # illustrative
58+
uses: example-actions/use-issues-create@v3 # illustrative
5959
with:
60-
use-issue-number: ${{ steps.create-issue.outputs.issue-number }}
61-
use-issue-url: ${{ steps.create-issue.outputs.issue-url }}
60+
use-issue-number: ${{ steps.issues-create.outputs.issue-number }}
61+
use-issue-url: ${{ steps.issues-create.outputs.issue-url }}
6262
```

‎docs/issues-get.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ run:
4242
steps:
4343
# ...
4444
- name: Gets an issue
45-
id: gets-an-issue # only necessary if using this action's output(s)
45+
id: issues-get # only necessary if using this action's output(s)
4646
uses: bitwizeshift/actions-github/issues/get@v1
4747
with:
4848
# Optional inputs
@@ -53,16 +53,16 @@ run:
5353
retry-exempt-status-codes: RETRY_EXEMPT_STATUS_CODES
5454
# ...
5555
- name: Uses "Gets an issue" Outputs
56-
uses: example-actions/use-gets-an-issue@v3 # illustrative
56+
uses: example-actions/use-issues-get@v3 # illustrative
5757
with:
58-
use-issue-api-url: ${{ steps.gets-an-issue.outputs.issue-api-url }}
59-
use-labels: ${{ steps.gets-an-issue.outputs.labels }}
60-
use-body: ${{ steps.gets-an-issue.outputs.body }}
61-
use-state: ${{ steps.gets-an-issue.outputs.state }}
62-
use-state-reason: ${{ steps.gets-an-issue.outputs.state-reason }}
63-
use-issue-number: ${{ steps.gets-an-issue.outputs.issue-number }}
64-
use-issue-url: ${{ steps.gets-an-issue.outputs.issue-url }}
65-
use-assignees: ${{ steps.gets-an-issue.outputs.assignees }}
66-
use-title: ${{ steps.gets-an-issue.outputs.title }}
67-
use-locked: ${{ steps.gets-an-issue.outputs.locked }}
58+
use-assignees: ${{ steps.issues-get.outputs.assignees }}
59+
use-body: ${{ steps.issues-get.outputs.body }}
60+
use-issue-api-url: ${{ steps.issues-get.outputs.issue-api-url }}
61+
use-issue-number: ${{ steps.issues-get.outputs.issue-number }}
62+
use-issue-url: ${{ steps.issues-get.outputs.issue-url }}
63+
use-labels: ${{ steps.issues-get.outputs.labels }}
64+
use-locked: ${{ steps.issues-get.outputs.locked }}
65+
use-state: ${{ steps.issues-get.outputs.state }}
66+
use-state-reason: ${{ steps.issues-get.outputs.state-reason }}
67+
use-title: ${{ steps.issues-get.outputs.title }}
6868
```

‎docs/issues-update-comment.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ run:
3737
steps:
3838
# ...
3939
- name: Update comment on Issue
40-
id: update-comment-on-issue # only necessary if using this action's output(s)
40+
id: issues-update-comment # only necessary if using this action's output(s)
4141
uses: bitwizeshift/actions-github/issues/update-comment@v1
4242
with:
4343
# Required inputs
@@ -51,8 +51,8 @@ run:
5151
retry-exempt-status-codes: RETRY_EXEMPT_STATUS_CODES
5252
# ...
5353
- name: Uses "Update comment on Issue" Outputs
54-
uses: example-actions/use-update-comment-on-issue@v3 # illustrative
54+
uses: example-actions/use-issues-update-comment@v3 # illustrative
5555
with:
56-
use-comment-id: ${{ steps.update-comment-on-issue.outputs.comment-id }}
57-
use-comment-url: ${{ steps.update-comment-on-issue.outputs.comment-url }}
56+
use-comment-id: ${{ steps.issues-update-comment.outputs.comment-id }}
57+
use-comment-url: ${{ steps.issues-update-comment.outputs.comment-url }}
5858
```

‎docs/releases-create.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ run:
4343
steps:
4444
# ...
4545
- name: Create a release
46-
id: create-a-release # only necessary if using this action's output(s)
46+
id: releases-create # only necessary if using this action's output(s)
4747
uses: bitwizeshift/actions-github/releases/create@v1
4848
with:
4949
# Required inputs
@@ -62,9 +62,9 @@ run:
6262
target-commitish: TARGET_COMMITISH
6363
# ...
6464
- name: Uses "Create a release" Outputs
65-
uses: example-actions/use-create-a-release@v3 # illustrative
65+
uses: example-actions/use-releases-create@v3 # illustrative
6666
with:
67-
use-release-id: ${{ steps.create-a-release.outputs.release-id }}
68-
use-release-url: ${{ steps.create-a-release.outputs.release-url }}
69-
use-release-api-url: ${{ steps.create-a-release.outputs.release-api-url }}
67+
use-release-api-url: ${{ steps.releases-create.outputs.release-api-url }}
68+
use-release-id: ${{ steps.releases-create.outputs.release-id }}
69+
use-release-url: ${{ steps.releases-create.outputs.release-url }}
7070
```

0 commit comments

Comments
 (0)