Skip to content

github-action.md

Latest commit

 

History

History
103 lines (77 loc) · 6.14 KB

github-action.md

File metadata and controls

103 lines (77 loc) · 6.14 KB
title GitHub Action Integration
description Use CI Dokumentor as a GitHub Action in your workflows for automated documentation generation
sidebar_position 2

CI Dokumentor can be used directly as a GitHub Action in your workflows, making it easy to automatically generate and maintain documentation for your CI/CD components.

Usage

- uses: hoverkraft-tech/ci-dokumentor@2cfa34821d58c4814fe8056a4a001fbcd2c21be2 # main
  with:
    # Source manifest file path to handle (e.g. `action.yml`, `.github/workflows/ci.yml`).
    # This input is required.
    source: ''

    # Destination path for generated documentation (optional; destination is auto-detected if not specified by the adapter).
    destination: ''

    # Repository platform (auto-detected if not specified).
    repository: ''

    # CI/CD platform (`github-actions`, `gitlab-ci`, etc.).
    cicd: ''

    # Comma-separated list of sections to include.
    include-sections: ''

    # Comma-separated list of sections to exclude.
    exclude-sections: ''

    # Whether to perform a dry run (no files are written).
    # Default: `false`
    dry-run: 'false'

    # Version to document (auto-detected if not specified).
    version: ''

    # JSON array of extra badges to include in the documentation.
    # Each badge should have `label`, `url`, and optional `linkUrl` properties.
    extra-badges: ''

    # Transform bare URLs to links.
    # Types: `auto` (autolinks), `full` (full links), `false` (disabled).
    #
    # Default: `auto`
    format-link: auto

    # The GitHub token used to fetch repository information.
    # Default: `${{ github.token }}`
    github-token: ${{ github.token }}

    # Version of CI Dokumentor to use. See https://github.com/hoverkraft-tech/ci-dokumentor/releases.
    # Default: `latest`
    ci-dokumentor-version: latest

Inputs

Input Description Required Default
source Source manifest file path to handle (e.g. action.yml, .github/workflows/ci.yml). true -
destination Destination path for generated documentation (optional; destination is auto-detected if not specified by the adapter). false -
repository Repository platform (auto-detected if not specified). false -
cicd CI/CD platform (github-actions, gitlab-ci, etc.). false -
include-sections Comma-separated list of sections to include. false -
exclude-sections Comma-separated list of sections to exclude. false -
dry-run Whether to perform a dry run (no files are written). false false
version Version to document (auto-detected if not specified). false -
extra-badges JSON array of extra badges to include in the documentation. false -
Each badge should have label, url, and optional linkUrl properties.
format-link Transform bare URLs to links. false auto
Types: auto (autolinks), full (full links), false (disabled).
github-token The GitHub token used to fetch repository information. false ${{ github.token }}
ci-dokumentor-version Version of CI Dokumentor to use. See https://github.com/hoverkraft-tech/ci-dokumentor/releases. false latest

Outputs

Output Description
destination Destination path for generated documentation.

Related Documentation