gitlabhq/gitlabhq

View on GitHub
.gitlab/ci/docs.gitlab-ci.yml

Summary

Maintainability
Test Coverage
.review-docs:
  extends:
    - .default-tags
    - .default-retry
    - .only:variables-canonical-dot-com
    - .only:changes-docs
  only:
    refs:
      - merge_requests
  image: ruby:2.6-alpine
  stage: review
  dependencies: []
  variables:
    # We're cloning the repo instead of downloading the script for now
    # because some repos are private and CI_JOB_TOKEN cannot access files.
    # See https://gitlab.com/gitlab-org/gitlab/issues/191273
    GIT_DEPTH: 1
  environment:
    name: review-docs/$DOCS_GITLAB_REPO_SUFFIX-$CI_MERGE_REQUEST_IID
    # DOCS_REVIEW_APPS_DOMAIN and DOCS_GITLAB_REPO_SUFFIX are CI variables
    # Discussion: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/14236/diffs#note_40140693
    url: http://docs-preview-$DOCS_GITLAB_REPO_SUFFIX-$CI_MERGE_REQUEST_IID.$DOCS_REVIEW_APPS_DOMAIN/$DOCS_GITLAB_REPO_SUFFIX
    on_stop: review-docs-cleanup
  before_script:
    - apk add --update openssl
    - gem install httparty --no-document --version 0.17.3
    - gem install gitlab --no-document --version 4.13.0

# Always trigger a docs build in gitlab-docs only on docs-only branches.
# Useful to preview the docs changes live.
review-docs-deploy:
  extends: .review-docs
  script:
    - ./scripts/trigger-build-docs deploy
  when: manual

# Cleanup remote environment of gitlab-docs
review-docs-cleanup:
  extends: .review-docs
  environment:
    name: review-docs/$DOCS_GITLAB_REPO_SUFFIX-$CI_MERGE_REQUEST_IID
    action: stop
  script:
    - ./scripts/trigger-build-docs cleanup
  when: manual

docs lint:
  extends:
    - .default-tags
    - .default-retry
    - .default-only
    - .only:changes-docs
  image: "registry.gitlab.com/gitlab-org/gitlab-docs:docs-lint"
  stage: test
  dependencies: []
  script:
    - scripts/lint-doc.sh
    # Lint Markdown
    - markdownlint --config .markdownlint.json 'doc/**/*.md'
    # Prepare docs for build
    - mv doc/ /tmp/gitlab-docs/content/$DOCS_GITLAB_REPO_SUFFIX
    - cd /tmp/gitlab-docs
    # Build HTML from Markdown
    - bundle exec nanoc
    # Check the internal links
    - bundle exec nanoc check internal_links
    # Check the internal anchor links
    - bundle exec nanoc check internal_anchors

graphql-reference-verify:
  extends:
    - .only-ee
    - .default-tags
    - .default-retry
    - .default-cache
    - .default-only
    - .default-before_script
    - .only:changes-code-backstage-qa
    - .use-pg9
  stage: test
  needs: ["setup-test-env"]
  script:
    - bundle exec rake gitlab:graphql:check_docs
    - bundle exec rake gitlab:graphql:check_schema