Skip to content

Commit 3737b5e

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

4 files changed

Lines changed: 1567 additions & 715 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/ed19fc749543a82f50dbc89c5b6e8bba6ee7cd408bad3a0d6748179b2681f1ec/hoverkraft-tech/public-docs" width="60px" align="center" alt="Generate Documentation" />
6+
<img src="https://opengraph.githubassets.com/efbd18cb84cbe3703a9016b88d1bc7caf6c9721cc224b2740b27661a99591faf/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@fca4a9a32575438db28e9b8ad81d97758eca84c4 # main
40+
- uses: hoverkraft-tech/public-docs/.github/actions/generate-docs@5c0a48344f63f0827cb736e682da913db1efcd7b # main
4141
with:
4242
# GitHub token used to authenticate repository queries.
4343
# This input is required.

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

Lines changed: 20 additions & 14 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/ee8743035f4d97b88b8e03937037b13ca280a32c2398978b76e268b0fa4cf3b1/hoverkraft-tech/public-docs" width="60px" align="center" alt="Push Documentation Helper" />
6+
<img src="https://opengraph.githubassets.com/efbd18cb84cbe3703a9016b88d1bc7caf6c9721cc224b2740b27661a99591faf/hoverkraft-tech/public-docs" width="60px" align="center" alt="Push Documentation Helper" />
77
</div>
88

99
---
@@ -22,8 +22,7 @@
2222
## Overview
2323

2424
Reusable workflow that bundles project docs and triggers public portal sync
25-
26-
- Collects readme and docs Markdown, adds sync metadata, and uploads a short-lived artifact
25+
- Collects README and docs markdown, adds sync metadata, and uploads a short-lived artifact
2726
- Dispatches a repository event so hoverkraft-tech/public-docs can ingest and publish updates
2827

2928
<!-- overview:end -->
@@ -63,14 +62,19 @@ on:
6362
- main
6463
jobs:
6564
sync-docs-dispatcher:
66-
uses: hoverkraft-tech/public-docs/.github/workflows/sync-docs-dispatcher.yml@4ab9c098ba58ed7f19ae6e879516c04ed5379d1a # copilot/centralize-project-documentation
65+
uses: hoverkraft-tech/public-docs/.github/workflows/sync-docs-dispatcher.yml@5c0a48344f63f0827cb736e682da913db1efcd7b # main
6766
secrets:
6867
# GitHub token with write access to trigger repository_dispatch in public-docs
6968
# This input is required.
70-
PUBLIC_DOCS_TOKEN: ""
69+
github-token: ""
7170
with:
72-
# Path to documentation in source repo (default: docs)
73-
paths: docs
71+
# Path(s) to documentation in source repo (default: docs).
72+
# Accepts newline-separated list.
73+
# Accepts both files and directories.
74+
# Accepts glob patterns.
75+
#
76+
# This input is required.
77+
paths: ""
7478
```
7579
7680
<!-- usage:end -->
@@ -124,19 +128,21 @@ jobs:
124128

125129
### Workflow Call Inputs
126130

127-
| **Input** | **Description** | **Required** | **Type** | **Default** |
128-
| -------------------- | ---------------------------------------------------------- | ------------ | ----------- | ----------- |
129-
| **`docs_path`** | Path to documentation in source repository (default: docs) | **false** | **string** | `docs` |
130-
| **`include_readme`** | Include README.md from repository root | **false** | **boolean** | `true` |
131+
| **Input** | **Description** | **Required** | **Type** | **Default** |
132+
| ----------- | -------------------------------------------------------- | ------------ | ---------- | ----------- |
133+
| **`paths`** | Path(s) to documentation in source repo (default: docs). | **true** | **string** | - |
134+
| | Accepts newline-separated list. | | | |
135+
| | Accepts both files and directories. | | | |
136+
| | Accepts glob patterns. | | | |
131137

132138
<!-- inputs:end -->
133139
<!-- secrets:start -->
134140

135141
## Secrets
136142

137-
| **Secret** | **Description** | **Required** |
138-
| ----------------------- | ---------------------------------------------------------------------------- | ------------ |
139-
| **`PUBLIC_DOCS_TOKEN`** | GitHub token with write access to trigger repository_dispatch in public-docs | **true** |
143+
| **Secret** | **Description** | **Required** |
144+
| ------------------ | ---------------------------------------------------------------------------- | ------------ |
145+
| **`github-token`** | GitHub token with write access to trigger repository_dispatch in public-docs | **true** |
140146

141147
<!-- secrets:end -->
142148
<!-- outputs:start -->

0 commit comments

Comments
 (0)