Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 1.96 KB

README.md

File metadata and controls

41 lines (28 loc) · 1.96 KB

Components Documentation

Components

labdoc-generate

A GitLab CI/CD Component for generating Markdown documentation from GitLab CI/CD Components using labdoc.

Usage of component labdoc-generate

You can add this component to an existing .gitlab-ci.yml file by using the include: keyword.

include:
  - component: "gitlab.com/erNail/labdoc/labdoc-generate@latest"
    inputs: {}

You can configure the component with the inputs documented below.

Inputs of component labdoc-generate

Name Description Type Default Options Regex Mandatory
additional-labdoc-parameters Additional parameters to add to the labdoc generate command. If you want this job to only check if your existing documentation is up-to-date, use the --check flag. string "" - - No
image The image to use for running labdoc. string ernail/labdoc:1.1.0 - - No
labdoc-generate-job-extends The jobs that the job that generates the documentation should inherit from. array [] - - No
labdoc-generate-job-name The name of the job that generates the documentation. string labdoc-generate-job - - No
output-file-path The path and name of the rendered file to be created. string templates/README.md - - No
repo-url The repository URL from which to include the GitLab CI/CD Component. Will be used in the documentation. string - - - Yes
stage The stage of the jobs for generating the documentation. string docs - - No

Jobs of component labdoc-generate

The component will add the following jobs to your CI/CD Pipeline.

$[[ inputs.labdoc-generate-job-name ]]

Generates Markdown documentation from GitLab CI/CD Components. The generated documentation will be uploaded as an artifact at $[[ inputs.output-file-path ]].