|
3 | 3 | # GitHub Reusable Workflow: Push Documentation Helper |
4 | 4 |
|
5 | 5 | <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" /> |
7 | 7 | </div> |
8 | 8 |
|
9 | 9 | --- |
|
22 | 22 | ## Overview |
23 | 23 |
|
24 | 24 | 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 |
27 | 26 | - Dispatches a repository event so hoverkraft-tech/public-docs can ingest and publish updates |
28 | 27 |
|
29 | 28 | <!-- overview:end --> |
|
63 | 62 | - main |
64 | 63 | jobs: |
65 | 64 | 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 |
67 | 66 | secrets: |
68 | 67 | # GitHub token with write access to trigger repository_dispatch in public-docs |
69 | 68 | # This input is required. |
70 | | - PUBLIC_DOCS_TOKEN: "" |
| 69 | + github-token: "" |
71 | 70 | 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: "" |
74 | 78 | ``` |
75 | 79 |
|
76 | 80 | <!-- usage:end --> |
@@ -124,19 +128,21 @@ jobs: |
124 | 128 |
|
125 | 129 | ### Workflow Call Inputs |
126 | 130 |
|
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. | | | | |
131 | 137 |
|
132 | 138 | <!-- inputs:end --> |
133 | 139 | <!-- secrets:start --> |
134 | 140 |
|
135 | 141 | ## Secrets |
136 | 142 |
|
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** | |
140 | 146 |
|
141 | 147 | <!-- secrets:end --> |
142 | 148 | <!-- outputs:start --> |
|
0 commit comments