Prepare Markdown documentation pulled from an artifact before publishing it to the portal.
Responsibilities:
- Sanitize incoming file paths.
- Copy supporting assets into a sandbox directory.
- Inject sync metadata into Markdown and MDX files.
- Generate a default index page and metadata manifest when missing.
- uses: hoverkraft-tech/public-docs/.github/actions/prepare-docs@c40c17f7d6a8090950b3ef4bfc70502707a6bb9f # 0.3.0
with:
# GitHub token used to resolve workflow run metadata.
# This input is required.
github-token: ""
# Source repository that produced the documentation.
# This input is required.
source-repository: ""
# Workflow run identifier associated with the documentation sync.
# This input is required.
run-id: ""
# Directory where the documentation artifact was downloaded.
# Default: `documentation-download`
artifact-path: documentation-download
# Documentation path within the portal where the docs will be injected.
# This input is required.
docs-path: ""
# Static asset path within the portal where supporting files will be stored.
# This input is required.
static-path: ""| Input | Description | Required | Default |
|---|---|---|---|
github-token |
GitHub token used to resolve workflow run metadata. | true | - |
source-repository |
Source repository that produced the documentation. | true | - |
run-id |
Workflow run identifier associated with the documentation sync. | true | - |
artifact-path |
Directory where the documentation artifact was downloaded. | false | documentation-download |
docs-path |
Documentation path within the portal where the docs will be injected. | true | - |
static-path |
Static asset path within the portal where supporting files will be stored. | true | - |
| Output | Description |
|---|---|
source-branch |
Source branch resolved for the documentation run. |
output-path |
Path to the prepared documentation content. |
processed-files |
List of processed documentation files. |
Contributions are welcome! Please see the contributing guidelines for more details.
This project is licensed under the MIT License.
SPDX-License-Identifier: MIT
Copyright © 2026 hoverkraft-tech
For more details, see the license.
This documentation was automatically generated by CI Dokumentor.