Skip to content

Latest commit

 

History

History
106 lines (73 loc) · 3.83 KB

File metadata and controls

106 lines (73 loc) · 3.83 KB

GitHub Action: Resolve Documentation Target

Resolve Documentation Target

Marketplace Release License Stars PRs Welcome

Overview

Resolve documentation and static paths for a repository dispatch payload.

Responsibilities:

  • Fetch repository metadata and topics.
  • Determine the repository category via RepositoryCategorizer.
  • Compute the destination docs/static paths.

Usage

- uses: hoverkraft-tech/public-docs/.github/actions/resolve-docs-target@c40c17f7d6a8090950b3ef4bfc70502707a6bb9f # 0.3.0
  with:
    # GitHub token used to authenticate repository queries.
    # This input is required.
    github-token: ""

    # Repository slug in the form owner/repo.
    # This input is required.
    repository: ""

Inputs

Input Description Required Default
github-token GitHub token used to authenticate repository queries. true -
repository Repository slug in the form owner/repo. true -

Outputs

Output Description
docs-path Documentation path within the portal where the docs will be injected.
static-path Static asset path within the portal where supporting files will be stored.
category-name Resolved category name.
category-slug Resolved category slug.
sanitized-repo-name Sanitized repository name used as the final path segment.

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.