debian-mirror-gitlab/.gitlab/ci/docs.gitlab-ci.yml

70 lines
2.1 KiB
YAML
Raw Normal View History

2019-12-04 20:38:33 +05:30
.review-docs:
extends:
- .default-tags
- .default-retry
- .only-docs-changes
only:
refs:
- merge_requests
variables:
- $CI_SERVER_HOST == "gitlab.com" && $CI_PROJECT_NAMESPACE == "gitlab-org"
image: ruby:2.6-alpine
stage: review
dependencies: []
2019-07-31 22:56:46 +05:30
variables:
2019-12-04 20:38:33 +05:30
GIT_STRATEGY: none
2019-07-31 22:56:46 +05:30
environment:
name: review-docs/$CI_COMMIT_REF_SLUG
# DOCS_REVIEW_APPS_DOMAIN and DOCS_GITLAB_REPO_SUFFIX are CI variables
2019-12-04 20:38:33 +05:30
# Discussion: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/14236/diffs#note_40140693
2019-07-31 22:56:46 +05:30
url: http://$CI_ENVIRONMENT_SLUG.$DOCS_REVIEW_APPS_DOMAIN/$DOCS_GITLAB_REPO_SUFFIX
on_stop: review-docs-cleanup
2019-12-04 20:38:33 +05:30
before_script:
# We don't clone the repo by using GIT_STRATEGY: none and only download the
# single script we need here so it's much faster than cloning.
- apk add --update openssl
- wget $CI_PROJECT_URL/raw/$CI_COMMIT_SHA/scripts/trigger-build-docs
- chmod 755 trigger-build-docs
2019-07-31 22:56:46 +05:30
- gem install gitlab --no-document
# Always trigger a docs build in gitlab-docs only on docs-only branches.
# Useful to preview the docs changes live.
review-docs-deploy:
2019-12-04 20:38:33 +05:30
extends: .review-docs
2019-07-31 22:56:46 +05:30
script:
2019-12-04 20:38:33 +05:30
- ./trigger-build-docs deploy
when: manual
2019-07-31 22:56:46 +05:30
# Cleanup remote environment of gitlab-docs
review-docs-cleanup:
2019-12-04 20:38:33 +05:30
extends: .review-docs
2019-07-31 22:56:46 +05:30
environment:
name: review-docs/$CI_COMMIT_REF_SLUG
action: stop
script:
2019-12-04 20:38:33 +05:30
- ./trigger-build-docs cleanup
2019-07-31 22:56:46 +05:30
when: manual
docs lint:
2019-12-04 20:38:33 +05:30
extends:
- .default-tags
- .default-retry
- .default-only
- .only-docs-changes
2019-07-31 22:56:46 +05:30
image: "registry.gitlab.com/gitlab-org/gitlab-build-images:gitlab-docs-lint"
stage: test
dependencies: []
script:
- scripts/lint-doc.sh
2019-12-04 20:38:33 +05:30
# Lint Markdown
- markdownlint --config .markdownlint.json 'doc/**/*.md'
# Prepare docs for build
2019-07-31 22:56:46 +05:30
- 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