|
| 1 | +<!-- header:start --> |
| 2 | + |
| 3 | +# GitHub Reusable Workflow: Push Documentation Helper |
| 4 | + |
| 5 | +<div align="center"> |
| 6 | + <img src="https://opengraph.githubassets.com/ee8743035f4d97b88b8e03937037b13ca280a32c2398978b76e268b0fa4cf3b1/hoverkraft-tech/public-docs" width="60px" align="center" alt="Push Documentation Helper" /> |
| 7 | +</div> |
| 8 | + |
| 9 | +--- |
| 10 | + |
| 11 | +<!-- header:end --> |
| 12 | +<!-- badges:start --> |
| 13 | + |
| 14 | +[](https://github.com/hoverkraft-tech/public-docs/releases) |
| 15 | +[](http://choosealicense.com/licenses/mit/) |
| 16 | +[](https://img.shields.io/github/stars/hoverkraft-tech/public-docs?style=social) |
| 17 | +[](https://github.com/hoverkraft-tech/public-docs/blob/main/CONTRIBUTING.md) |
| 18 | + |
| 19 | +<!-- badges:end --> |
| 20 | +<!-- overview:start --> |
| 21 | + |
| 22 | +## Overview |
| 23 | + |
| 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 |
| 27 | +- Dispatches a repository event so hoverkraft-tech/public-docs can ingest and publish updates |
| 28 | + |
| 29 | +<!-- overview:end --> |
| 30 | +<!-- usage:start --> |
| 31 | + |
| 32 | +## Usage |
| 33 | + |
| 34 | +```yaml |
| 35 | +name: Push Documentation Helper |
| 36 | +on: |
| 37 | + push: |
| 38 | + branches: |
| 39 | + - main |
| 40 | +jobs: |
| 41 | + sync-docs-dispatcher: |
| 42 | + uses: hoverkraft-tech/public-docs/.github/workflows/sync-docs-dispatcher.yml@4ab9c098ba58ed7f19ae6e879516c04ed5379d1a # copilot/centralize-project-documentation |
| 43 | + secrets: |
| 44 | + # GitHub token with write access to trigger repository_dispatch in public-docs |
| 45 | + # This input is required. |
| 46 | + PUBLIC_DOCS_TOKEN: "" |
| 47 | + with: |
| 48 | + # Path to documentation in source repo (default: docs) |
| 49 | + # Default: `docs` |
| 50 | + docs_path: docs |
| 51 | + |
| 52 | + # Include README.md from repository root |
| 53 | + # Default: `true` |
| 54 | + include_readme: true |
| 55 | +``` |
| 56 | +
|
| 57 | +<!-- usage:end --> |
| 58 | +<!-- inputs:start --> |
| 59 | +
|
| 60 | +## Inputs |
| 61 | +
|
| 62 | +### Workflow Call Inputs |
| 63 | +
|
| 64 | +| **Input** | **Description** | **Required** | **Type** | **Default** | |
| 65 | +| -------------------- | ---------------------------------------------------- | ------------ | ----------- | ----------- | |
| 66 | +| **`docs_path`** | Path to documentation in source repository (default: docs) | **false** | **string** | `docs` | |
| 67 | +| **`include_readme`** | Include README.md from repository root | **false** | **boolean** | `true` | |
| 68 | + |
| 69 | +<!-- inputs:end --> |
| 70 | +<!-- secrets:start --> |
| 71 | + |
| 72 | +## Secrets |
| 73 | + |
| 74 | +| **Secret** | **Description** | **Required** | |
| 75 | +| ----------------------- | ---------------------------------------------------------------------------- | ------------ | |
| 76 | +| **`PUBLIC_DOCS_TOKEN`** | GitHub token with write access to trigger repository_dispatch in public-docs | **true** | |
| 77 | + |
| 78 | +<!-- secrets:end --> |
| 79 | +<!-- outputs:start --> |
| 80 | +<!-- outputs:end --> |
| 81 | +<!-- examples:start --> |
| 82 | +<!-- examples:end --> |
| 83 | +<!-- contributing:start --> |
| 84 | + |
| 85 | +## Contributing |
| 86 | + |
| 87 | +Contributions are welcome! Please see the [contributing guidelines](https://github.com/hoverkraft-tech/public-docs/blob/main/CONTRIBUTING.md) for more details. |
| 88 | + |
| 89 | +<!-- contributing:end --> |
| 90 | +<!-- security:start --> |
| 91 | +<!-- security:end --> |
| 92 | +<!-- license:start --> |
| 93 | + |
| 94 | +## License |
| 95 | + |
| 96 | +This project is licensed under the MIT License. |
| 97 | + |
| 98 | +SPDX-License-Identifier: MIT |
| 99 | + |
| 100 | +Copyright © 2025 hoverkraft-tech |
| 101 | + |
| 102 | +For more details, see the [license](http://choosealicense.com/licenses/mit/). |
| 103 | + |
| 104 | +<!-- license:end --> |
| 105 | +<!-- generated:start --> |
| 106 | + |
| 107 | +--- |
| 108 | + |
| 109 | +This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor). |
| 110 | + |
| 111 | +<!-- generated:end --> |
0 commit comments