79 lines
2.4 KiB
YAML
79 lines
2.4 KiB
YAML
.review-docs: &review-docs
|
|
extends: .single-script-job-dedicated-runner
|
|
variables:
|
|
SCRIPT_NAME: trigger-build-docs
|
|
environment:
|
|
name: review-docs/$CI_COMMIT_REF_SLUG
|
|
# DOCS_REVIEW_APPS_DOMAIN and DOCS_GITLAB_REPO_SUFFIX are CI variables
|
|
# Discussion: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/14236/diffs#note_40140693
|
|
url: http://$CI_ENVIRONMENT_SLUG.$DOCS_REVIEW_APPS_DOMAIN/$DOCS_GITLAB_REPO_SUFFIX
|
|
on_stop: review-docs-cleanup
|
|
|
|
# Trigger a manual docs build in gitlab-docs only on non docs-only branches.
|
|
# Useful to preview the docs changes live.
|
|
review-docs-deploy-manual:
|
|
extends:
|
|
- .review-docs
|
|
- .no-docs-and-no-qa
|
|
stage: build
|
|
script:
|
|
- gem install gitlab --no-document
|
|
- ./$SCRIPT_NAME deploy
|
|
when: manual
|
|
only:
|
|
- branches@gitlab-org/gitlab-ce
|
|
- branches@gitlab-org/gitlab-ee
|
|
|
|
# Always trigger a docs build in gitlab-docs only on docs-only branches.
|
|
# Useful to preview the docs changes live.
|
|
review-docs-deploy:
|
|
<<: *review-docs
|
|
stage: post-test
|
|
script:
|
|
- gem install gitlab --no-document
|
|
- ./$SCRIPT_NAME deploy
|
|
only:
|
|
- /(^docs[\/-].*|.*-docs$)/@gitlab-org/gitlab-ce
|
|
- /(^docs[\/-].*|.*-docs$)/@gitlab-org/gitlab-ee
|
|
except:
|
|
- /(^qa[\/-].*|.*-qa$)/
|
|
|
|
# Cleanup remote environment of gitlab-docs
|
|
review-docs-cleanup:
|
|
<<: *review-docs
|
|
stage: post-cleanup
|
|
environment:
|
|
name: review-docs/$CI_COMMIT_REF_SLUG
|
|
action: stop
|
|
script:
|
|
- gem install gitlab --no-document
|
|
- ./$SCRIPT_NAME cleanup
|
|
when: manual
|
|
only:
|
|
- branches@gitlab-org/gitlab-ce
|
|
- branches@gitlab-org/gitlab-ee
|
|
|
|
docs lint:
|
|
extends: .dedicated-runner
|
|
image: "registry.gitlab.com/gitlab-org/gitlab-build-images:gitlab-docs-lint"
|
|
stage: test
|
|
cache: {}
|
|
dependencies: []
|
|
before_script: []
|
|
script:
|
|
- scripts/lint-doc.sh
|
|
- scripts/lint-changelog-yaml
|
|
- mv doc/ /tmp/gitlab-docs/content/$DOCS_GITLAB_REPO_SUFFIX
|
|
- cd /tmp/gitlab-docs
|
|
# Lint Markdown
|
|
# https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
|
|
- bundle exec mdl content/$DOCS_GITLAB_REPO_SUFFIX/**/*.md --ignore-front-matter --rules \
|
|
MD001,MD032,MD034
|
|
# 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
|
|
except:
|
|
- /(^qa[\/-].*|.*-qa$)/
|