Skip to content

Commit 2507115

Browse files
docs: update action documentation
[skip ci] Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 1d19389 commit 2507115

5 files changed

Lines changed: 16 additions & 16 deletions

File tree

.github/actions/generate-docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# GitHub Action: Generate Documentation
44

55
<div align="center">
6-
<img src="https://opengraph.githubassets.com/2a02d8d63b856a94e60178eff374fd909a5a86f56bc6cee66ffea2d24ba86468/hoverkraft-tech/public-docs" width="60px" align="center" alt="Generate Documentation" />
6+
<img src="https://opengraph.githubassets.com/5a088cadf406da307cc56fe4e656d3e159842a11b206bd93433312f35ca6b035/hoverkraft-tech/public-docs" width="60px" align="center" alt="Generate Documentation" />
77
</div>
88

99
---
@@ -37,7 +37,7 @@ Features:
3737
## Usage
3838

3939
```yaml
40-
- uses: hoverkraft-tech/public-docs/.github/actions/generate-docs@c40c17f7d6a8090950b3ef4bfc70502707a6bb9f # 0.3.0
40+
- uses: hoverkraft-tech/public-docs/.github/actions/generate-docs@88d526c66b61dd888b382018beeaff53a6540ed3 # main
4141
with:
4242
# GitHub token used to authenticate repository queries.
4343
# This input is required.

.github/actions/inject-docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# GitHub Action: Inject Documentation
44

55
<div align="center">
6-
<img src="https://opengraph.githubassets.com/2a02d8d63b856a94e60178eff374fd909a5a86f56bc6cee66ffea2d24ba86468/hoverkraft-tech/public-docs" width="60px" align="center" alt="Inject Documentation" />
6+
<img src="https://opengraph.githubassets.com/5a088cadf406da307cc56fe4e656d3e159842a11b206bd93433312f35ca6b035/hoverkraft-tech/public-docs" width="60px" align="center" alt="Inject Documentation" />
77
</div>
88

99
---
@@ -35,7 +35,7 @@ Responsibilities:
3535
## Usage
3636

3737
```yaml
38-
- uses: hoverkraft-tech/public-docs/.github/actions/inject-docs@c40c17f7d6a8090950b3ef4bfc70502707a6bb9f # 0.3.0
38+
- uses: hoverkraft-tech/public-docs/.github/actions/inject-docs@88d526c66b61dd888b382018beeaff53a6540ed3 # main
3939
with:
4040
# Source repository that produced the documentation.
4141
# This input is required.

.github/actions/prepare-docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# GitHub Action: Prepare Documentation Bundle
44

55
<div align="center">
6-
<img src="https://opengraph.githubassets.com/2a02d8d63b856a94e60178eff374fd909a5a86f56bc6cee66ffea2d24ba86468/hoverkraft-tech/public-docs" width="60px" align="center" alt="Prepare Documentation Bundle" />
6+
<img src="https://opengraph.githubassets.com/5a088cadf406da307cc56fe4e656d3e159842a11b206bd93433312f35ca6b035/hoverkraft-tech/public-docs" width="60px" align="center" alt="Prepare Documentation Bundle" />
77
</div>
88

99
---

.github/actions/resolve-docs-target/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# GitHub Action: Resolve Documentation Target
44

55
<div align="center">
6-
<img src="https://opengraph.githubassets.com/2a02d8d63b856a94e60178eff374fd909a5a86f56bc6cee66ffea2d24ba86468/hoverkraft-tech/public-docs" width="60px" align="center" alt="Resolve Documentation Target" />
6+
<img src="https://opengraph.githubassets.com/5a088cadf406da307cc56fe4e656d3e159842a11b206bd93433312f35ca6b035/hoverkraft-tech/public-docs" width="60px" align="center" alt="Resolve Documentation Target" />
77
</div>
88

99
---
@@ -36,7 +36,7 @@ Responsibilities:
3636
## Usage
3737

3838
```yaml
39-
- uses: hoverkraft-tech/public-docs/.github/actions/resolve-docs-target@c40c17f7d6a8090950b3ef4bfc70502707a6bb9f # 0.3.0
39+
- uses: hoverkraft-tech/public-docs/.github/actions/resolve-docs-target@88d526c66b61dd888b382018beeaff53a6540ed3 # main
4040
with:
4141
# GitHub token used to authenticate repository queries.
4242
# This input is required.

.github/workflows/sync-docs-dispatcher.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# GitHub Reusable Workflow: Push Documentation Helper
44

55
<div align="center">
6-
<img src="https://opengraph.githubassets.com/2a02d8d63b856a94e60178eff374fd909a5a86f56bc6cee66ffea2d24ba86468/hoverkraft-tech/public-docs" width="60px" align="center" alt="Push Documentation Helper" />
6+
<img src="https://opengraph.githubassets.com/5a088cadf406da307cc56fe4e656d3e159842a11b206bd93433312f35ca6b035/hoverkraft-tech/public-docs" width="60px" align="center" alt="Push Documentation Helper" />
77
</div>
88

99
---
@@ -83,16 +83,16 @@ on:
8383
permissions: {}
8484
jobs:
8585
sync-docs-dispatcher:
86-
uses: hoverkraft-tech/public-docs/.github/workflows/sync-docs-dispatcher.yml@c40c17f7d6a8090950b3ef4bfc70502707a6bb9f # 0.3.0
86+
uses: hoverkraft-tech/public-docs/.github/workflows/sync-docs-dispatcher.yml@88d526c66b61dd888b382018beeaff53a6540ed3 # main
8787
permissions: {}
8888
secrets:
8989
# GitHub App private key to generate GitHub token in place of github-token.
9090
# See https://github.com/actions/create-github-app-token.
9191
github-app-key: ""
9292
with:
93-
# GitHub App ID to generate GitHub token in place of github-token.
93+
# GitHub App Client ID to generate GitHub token in place of github-token.
9494
# See https://github.com/actions/create-github-app-token.
95-
github-app-id: ""
95+
github-app-client-id: ""
9696

9797
# ID of the uploaded documentation artifact.
9898
#
@@ -321,11 +321,11 @@ After setting up sync-docs:
321321

322322
### Workflow Call Inputs
323323

324-
| **Input** | **Description** | **Required** | **Type** | **Default** |
325-
| ------------------- | ---------------------------------------------------------------- | ------------ | ---------- | ----------- |
326-
| **`github-app-id`** | GitHub App ID to generate GitHub token in place of github-token. | **false** | **string** | - |
327-
| | See <https://github.com/actions/create-github-app-token>. | | | |
328-
| **`artifact-id`** | ID of the uploaded documentation artifact. | **true** | **string** | - |
324+
| **Input** | **Description** | **Required** | **Type** | **Default** |
325+
| -------------------------- | ----------------------------------------------------------------------- | ------------ | ---------- | ----------- |
326+
| **`github-app-client-id`** | GitHub App Client ID to generate GitHub token in place of github-token. | **false** | **string** | - |
327+
| | See <https://github.com/actions/create-github-app-token>. | | | |
328+
| **`artifact-id`** | ID of the uploaded documentation artifact. | **true** | **string** | - |
329329

330330
<!-- inputs:end -->
331331
<!-- secrets:start -->

0 commit comments

Comments
 (0)