CI Dokumentor
Version updated for https://github.com/hoverkraft-tech/ci-dokumentor to version 0.3.0.
This publisher is shown as ‘verified’ by GitHub.
This action is used across all versions by 0 repositories.
Action Type
This is a Composite action.
Go to the GitHub Marketplace to find the latest changes.
Action Summary
CI Dokumentor is a GitHub Action that automates the generation of documentation for CI/CD components, such as workflows, pipelines, and configurations. It addresses the challenge of maintaining up-to-date documentation by automatically creating detailed and consistent documentation directly from source files like action.yml. Key capabilities include integration with platforms like Docker, GitHub Actions, and GitLab CI, offering flexibility and efficiency in streamlining documentation workflows.
What’s Changed
Release Summary
GitLab support is now available through a new repository provider and CI/CD documentation generator, while GitHub Actions examples now better handle job-level permissions.
Core markdown generation is more reliable for inline code, table code blocks, multiline content, special characters, and overview additional content.
Internal changes include shared section generator refactoring, documentation refreshes, dependency updates, and CI maintenance.
Breaking changes
There is no breaking change.
What’s Changed
- docs: update action documentation by @hoverkraft-bot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/202
- feat: add comprehensive GitLab support with repository provider and CI/CD generator by @Copilot in https://github.com/hoverkraft-tech/ci-dokumentor/pull/170
- refactor: factorize section generators at core level to avoid duplicates by @Copilot in https://github.com/hoverkraft-tech/ci-dokumentor/pull/204
- build(deps-dev): Bump the npm-dev-dependencies group with 7 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/206
- build(deps): Bump @gitbeaker/rest from 40.6.0 to 43.5.0 by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/207
- build(deps): Bump hoverkraft-tech/ci-github-publish from 0.10.1 to 0.11.2 in the github-actions-dependencies group by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/205
- build(deps-dev): Bump the npm-dev-dependencies group with 3 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/208
- build(deps): Bump hoverkraft-tech/ci-github-nodejs from 0.14.1 to 0.15.0 in the github-actions-dependencies group by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/209
- build(deps): Bump the github-actions-dependencies group with 2 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/210
- build(deps): Bump inversify from 7.10.2 to 7.10.3 by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/212
- build(deps-dev): Bump the npm-dev-dependencies group with 8 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/211
- build(deps-dev): Bump vite from 7.1.10 to 7.1.11 in the npm_and_yarn group across 1 directory by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/213
- fix(core): escape curly braces in inline code to prevent template interpolation by @Copilot in https://github.com/hoverkraft-tech/ci-dokumentor/pull/214
- docs: update action documentation by @hoverkraft-bot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/215
- build(deps): Bump p-limit from 7.1.1 to 7.2.0 by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/219
- build(deps): Bump hoverkraft-tech/ci-github-publish from 0.11.2 to 0.12.1 in the github-actions-dependencies group by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/216
- build(deps-dev): Bump the npm-dev-dependencies group with 18 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/218
- build(deps-dev): Bump @swc/core from 1.13.20 to 1.13.21 in the npm-dev-dependencies group by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/220
- build(deps): Bump the npm-docs-dependencies group across 1 directory with 5 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/217
- chore(cli): improve error message by @neilime in https://github.com/hoverkraft-tech/ci-dokumentor/pull/221
- build(deps): Bump commander from 14.0.1 to 14.0.2 by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/228
- build(deps): Bump simple-git from 3.28.0 to 3.29.0 by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/226
- build(deps): Bump @gitbeaker/rest from 43.5.0 to 43.7.0 by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/225
- build(deps): Bump @octokit/graphql from 9.0.2 to 9.0.3 by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/224
- build(deps-dev): Bump the npm-dev-dependencies group with 11 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/223
- build(deps): Bump the github-actions-dependencies group with 3 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/222
- build(deps-dev): Bump jsdom from 27.0.1 to 27.1.0 in the npm-dev-dependencies group across 1 directory by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/229
- build(deps): Bump inversify from 7.10.3 to 7.10.4 by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/227
- build(deps): Bump hoverkraft-tech/ci-github-publish from 0.12.1 to 0.13.0 in the github-actions-dependencies group by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/230
- build(deps): Bump hoverkraft-tech/ci-github-common from 0.27.0 to 0.28.0 in the github-actions-dependencies group by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/233
- build(deps): Bump @gitbeaker/rest from 43.7.0 to 43.8.0 by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/234
- build(deps): Bump simple-git from 3.29.0 to 3.30.0 by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/235
- build(deps-dev): Bump the npm-dev-dependencies group with 5 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/231
- feat(cicd-github-actions): merge and sort workflow permissions from job-level definitions by @Copilot in https://github.com/hoverkraft-tech/ci-dokumentor/pull/232
- build(deps-dev): Bump the npm-dev-dependencies group with 10 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/237
- build(deps-dev): Bump the npm-dev-dependencies group with 4 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/238
- build(deps): Bump the github-actions-dependencies group with 5 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/236
- build(deps-dev): Bump the npm-dev-dependencies group with 11 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/240
- feat(cicd-github): move permissions from root to job level in workflow usage examples by @Copilot in https://github.com/hoverkraft-tech/ci-dokumentor/pull/241
- build(deps): Bump the github-actions-dependencies group across 1 directory with 11 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/244
- build(deps-dev): Bump the npm-dev-dependencies group with 13 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/243
- build(deps-dev): Bump the npm-dev-dependencies group with 10 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/246
- build(deps): Bump the github-actions-dependencies group across 1 directory with 12 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/247
- build(deps): Bump yaml from 2.8.1 to 2.8.2 by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/251
- build(deps): Bump inversify from 7.10.4 to 7.10.5 by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/250
- build(deps-dev): Bump the npm-dev-dependencies group with 7 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/248
- build(deps): Bump react from 19.2.0 to 19.2.1 in the npm-docs-dependencies group by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/249
- build(deps): Bump inversify from 7.10.5 to 7.10.6 by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/255
- build(deps): Bump the npm-docs-dependencies group with 2 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/254
- build(deps-dev): Bump the npm-dev-dependencies group with 12 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/253
- build(deps): Bump the github-actions-dependencies group with 12 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/252
- fix(core): escape styling markdown chars in table code blocks by @neilime in https://github.com/hoverkraft-tech/ci-dokumentor/pull/256
- build(deps): Bump the github-actions-dependencies group with 2 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/257
- build(deps-dev): Bump the npm-dev-dependencies group with 10 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/258
- fix(core): handle multiline and special chars properly for markdown code by @neilime in https://github.com/hoverkraft-tech/ci-dokumentor/pull/259
- fix(core): do not escape braces in markdown code anymore by @neilime in https://github.com/hoverkraft-tech/ci-dokumentor/pull/260
- build(deps-dev): Bump the npm-dev-dependencies group with 15 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/262
- build(deps): Bump inversify from 7.10.6 to 7.10.8 by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/263
- build(deps): Bump the github-actions-dependencies group with 3 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/261
- build(deps-dev): Bump the npm-dev-dependencies group with 9 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/266
- build(deps): Bump the github-actions-dependencies group with 11 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/265
- build(deps-dev): Bump the npm-dev-dependencies group with 4 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/267
- docs: update action documentation by @hoverkraft-bot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/268
- build(deps): Bump inversify from 7.10.8 to 7.11.0 by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/270
- build(deps-dev): Bump the npm-dev-dependencies group with 3 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/269
- build(deps): Bump diff from 8.0.2 to 8.0.3 by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/271
- build(deps-dev): Bump the npm-dev-dependencies group with 8 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/272
- build(deps-dev): Bump the npm-dev-dependencies group with 14 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/274
- build(deps): Bump actions/checkout from 6.0.1 to 6.0.2 in the github-actions-dependencies group by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/273
- build(deps-dev): Bump the npm-dev-dependencies group with 11 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/275
- build(deps): Bump the npm-docs-dependencies group with 2 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/276
- build(deps): Bump p-limit from 7.2.0 to 7.3.0 by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/279
- build(deps): Bump commander from 14.0.2 to 14.0.3 by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/280
- build(deps-dev): Bump the npm-dev-dependencies group with 8 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/278
- build(deps): Bump the github-actions-dependencies group with 7 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/277
- build(deps-dev): Bump the npm-dev-dependencies group with 12 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/281
- build(deps): Bump simple-git from 3.30.0 to 3.31.1 in the npm-production-dependencies group by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/283
- build(deps): Bump the github-actions-dependencies group with 8 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/284
- build(deps-dev): Bump the npm-development-dependencies group across 1 directory with 13 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/286
- build(deps): Bump simple-git from 3.31.1 to 3.32.3 in the npm-production-dependencies group by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/289
- build(deps): Bump the github-actions-dependencies group with 2 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/287
- build(deps-dev): Bump the npm-development-dependencies group with 14 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/288
- build(deps-dev): Bump the npm-development-dependencies group with 7 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/290
- build(deps): Bump simple-git from 3.32.3 to 3.33.0 in the npm-production-dependencies group by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/293
- build(deps-dev): Bump the npm-development-dependencies group with 9 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/292
- build(deps): Bump actions/download-artifact from 8.0.0 to 8.0.1 in the github-actions-dependencies group by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/291
- build(deps-dev): Bump the npm-development-dependencies group with 10 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/295
- build(deps): Bump the github-actions-dependencies group with 3 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/294
- build(deps): Bump inversify from 7.11.0 to 8.1.0 in the npm-production-dependencies group by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/296
- build(deps): Bump yaml from 2.8.2 to 2.8.3 by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/297
- build(deps): Bump diff from 8.0.3 to 8.0.4 in the npm-production-dependencies group by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/300
- build(deps): Bump the github-actions-dependencies group with 6 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/298
- chore: upgrade minor dev deps by @neilime in https://github.com/hoverkraft-tech/ci-dokumentor/pull/301
- build(deps-dev): Bump vite from 8.0.3 to 8.0.5 by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/304
- build(deps): Bump the github-actions-dependencies group with 3 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/306
- build(deps): Bump simple-git from 3.33.0 to 3.35.2 in the npm-production-dependencies group by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/308
- build(deps): Bump the npm-production-dependencies group with 2 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/311
- build(deps): Bump ghcr.io/devcontainers/features/node from 1.7.1 to 2.0.0 by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/312
- fix(core): overview generator should append additional content if any by @neilime in https://github.com/hoverkraft-tech/ci-dokumentor/pull/314
- build(deps): Bump the github-actions-dependencies group across 1 directory with 13 updates by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/310
- build(deps): Bump yaml from 2.8.3 to 2.8.4 in the npm-production-dependencies group by @dependabot[bot] in https://github.com/hoverkraft-tech/ci-dokumentor/pull/315
- chore: upgrade dev dependencies by @neilime in https://github.com/hoverkraft-tech/ci-dokumentor/pull/317
Full Changelog: https://github.com/hoverkraft-tech/ci-dokumentor/compare/0.2.2...0.3.0