Skip to content

Latest commit

 

History

History
104 lines (72 loc) · 3.66 KB

File metadata and controls

104 lines (72 loc) · 3.66 KB

GitHub Action: Inject Documentation

Inject Documentation

Marketplace Release License Stars PRs Welcome

Overview

Inject prepared documentation content into the portal.

Responsibilities:

  • Replace the destination docs directory with prepared content.
  • Move prepared static assets (docs/static) into the portal static directory.

Usage

- uses: hoverkraft-tech/public-docs/.github/actions/inject-docs@c40c17f7d6a8090950b3ef4bfc70502707a6bb9f # 0.3.0
  with:
    # Source repository that produced the documentation.
    # This input is required.
    source-repository: ""

    # 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: ""

    # Directory containing the prepared documentation content.
    # This input is required.
    prepared-dir: ""

Inputs

Input Description Required Default
source-repository Source repository that produced the documentation. true -
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 -
prepared-dir Directory containing the prepared documentation content. true -

Contributing

Contributions are welcome! Please see the contributing guidelines for more details.

License

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.