hoverkraft-tech/CI Dokumentor
Automatically generate documentation for CI/CD components like GitHub Actions and workflows
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| source | Source manifest file path(s) to handle. Supports: - Single file: `action.yml` - Multiple files (space-separated): `action.yml .github/workflows/ci.yml` - Multiple files (newline-separated): Use multiline YAML string - Glob patterns: `*.yml` or `.github/workflows/*.yml` | yes | — |
| destination | Destination path for generated documentation (optional; destination is auto-detected if not specified by the adapter). Only applicable when processing a single file. | no | — |
| repository | Repository platform (auto-detected if not specified). | no | — |
| cicd | CI/CD platform (`github-actions`, `gitlab-ci`, etc.). | no | — |
| include-sections | Comma-separated list of sections to include. | no | — |
| exclude-sections | Comma-separated list of sections to exclude. | no | — |
| dry-run | Whether to perform a dry run (no files are written). | no | false |
| version | Version to document (auto-detected if not specified). | no | — |
| extra-badges | JSON array of extra badges to include in the documentation. Each badge should have `label`, `url`, and optional `linkUrl` properties. | no | "" |
| format-link | Transform bare URLs to links. Types: `auto` (autolinks), `full` (full links), `false` (disabled). | no | auto |
| concurrency | Maximum number of files to process concurrently when processing multiple files. | no | 5 |
| github-token | The GitHub token used to fetch repository information. | no | ${{ github.token }} |
| ci-dokumentor-version | Version of CI Dokumentor to use. See https://github.com/hoverkraft-tech/ci-dokumentor/releases. | no | latest |
Outputs
| name | description |
|---|---|
| destination | Destination path for generated documentation. |