Skip to main content

Publish wiki component

This pipeline pushes project's markdown files into the wiki repository for documentation purposes.

Variables

NamerequiredHints
GITLAB_TOKENnoNon-personal access token of a service account.

Limitations of CI_JOB_TOKEN:

Setup

  • Create a new folder docs
  • Create Markdown files in the folder docs
  • Create GitLab pipeline file .gitlab-ci.yml:
include:
- component: $CI_SERVER_FQDN/xrow-public/ci-tools/common@stable
- component: $CI_SERVER_FQDN/xrow-public/ci-tools/publish-wiki@stable

Inputs

NameDescriptionDefaultType
------------
dependenciesThe dependencies that this job depends on.[]array
nameName of the jobwikistring
needsThe jobs that this job depends on.[]array
pathPath to the documentation filesdocsstring
rulesThe jobs that this job depends on.[{"if":"$CI_PIPELINE_SOURCE == \"schedule\"","when":"never"},{"if":"\"$GITLAB_TOKEN\" == \"\"","when":"never"},{"if":"$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH","when":"on_success"},{"when":"never"}]array
stageThe stage to run the job indeploystring
tagsThe runners that this job depends on.[]array