77 lines
2.6 KiB
YAML
77 lines
2.6 KiB
YAML
.review-docs:
|
|
extends:
|
|
- .default-retry
|
|
- .docs:rules:review-docs
|
|
image: ${GITLAB_DEPENDENCY_PROXY}ruby:2.7-alpine
|
|
stage: review
|
|
needs: []
|
|
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
|
|
# By default, deploy the Review App using the `main` branch of the `gitlab-org/gitlab-docs` project
|
|
DOCS_BRANCH: main
|
|
environment:
|
|
name: review-docs/mr-${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
|
|
auto_stop_in: 2 weeks
|
|
url: http://${DOCS_BRANCH}-${DOCS_GITLAB_REPO_SUFFIX}-${CI_MERGE_REQUEST_IID}.${DOCS_REVIEW_APPS_DOMAIN}/${DOCS_GITLAB_REPO_SUFFIX}
|
|
on_stop: review-docs-cleanup
|
|
before_script:
|
|
- source ./scripts/utils.sh
|
|
- install_gitlab_gem
|
|
|
|
# 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
|
|
|
|
# Cleanup remote environment of gitlab-docs
|
|
review-docs-cleanup:
|
|
extends: .review-docs
|
|
environment:
|
|
name: review-docs/mr-${CI_MERGE_REQUEST_IID}
|
|
action: stop
|
|
script:
|
|
- ./scripts/trigger-build docs cleanup
|
|
|
|
docs-lint markdown:
|
|
extends:
|
|
- .default-retry
|
|
- .docs:rules:docs-lint
|
|
# When updating the image version here, update it in /scripts/lint-doc.sh too.
|
|
image: registry.gitlab.com/gitlab-org/gitlab-docs/lint-markdown:alpine-3.14-vale-2.10.4-markdownlint-0.28.1
|
|
stage: test
|
|
needs: []
|
|
script:
|
|
- scripts/lint-doc.sh
|
|
|
|
docs-lint links:
|
|
extends:
|
|
- .docs:rules:docs-lint
|
|
image: registry.gitlab.com/gitlab-org/gitlab-docs/lint-html:alpine-3.14-ruby-2.7.4-db71f027
|
|
stage: test
|
|
needs: []
|
|
script:
|
|
# Prepare docs for build
|
|
# The path must be 'ee/' because we have hardcoded links relying on it
|
|
# https://gitlab.com/gitlab-org/gitlab-docs/-/blob/887850752fc0e72856da6632db132f005ba77f16/content/index.erb#L44-63
|
|
- mv doc/ /tmp/gitlab-docs/content/ee
|
|
- cd /tmp/gitlab-docs
|
|
# Build HTML from Markdown
|
|
- bundle exec nanoc
|
|
# Check the internal links and anchors (in parallel)
|
|
- "parallel time bundle exec nanoc check ::: internal_links internal_anchors"
|
|
|
|
ui-docs-links lint:
|
|
extends:
|
|
- .docs:rules:docs-lint
|
|
- .static-analysis-base
|
|
stage: test
|
|
needs: []
|
|
script:
|
|
- bundle exec haml-lint -i DocumentationLinks
|