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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

93 lines
3 KiB
YAML
Raw Normal View History

2019-12-04 20:38:33 +05:30
.review-docs:
extends:
- .default-retry
2020-03-13 15:44:24 +05:30
- .docs:rules:review-docs
2022-11-25 23:54:43 +05:30
image: ${GITLAB_DEPENDENCY_PROXY_ADDRESS}ruby:${RUBY_VERSION}-alpine
2019-12-04 20:38:33 +05:30
stage: review
2021-01-03 14:25:43 +05:30
needs: []
2019-07-31 22:56:46 +05:30
variables:
2020-03-13 15:44:24 +05:30
# 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
2021-09-04 01:27:46 +05:30
# By default, deploy the Review App using the `main` branch of the `gitlab-org/gitlab-docs` project
DOCS_BRANCH: main
2019-07-31 22:56:46 +05:30
environment:
2021-04-29 21:17:54 +05:30
name: review-docs/mr-${CI_MERGE_REQUEST_IID}
2019-07-31 22:56:46 +05:30
# 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
2020-04-08 14:13:33 +05:30
auto_stop_in: 2 weeks
2021-04-29 21:17:54 +05:30
url: http://${DOCS_BRANCH}-${DOCS_GITLAB_REPO_SUFFIX}-${CI_MERGE_REQUEST_IID}.${DOCS_REVIEW_APPS_DOMAIN}/${DOCS_GITLAB_REPO_SUFFIX}
2019-07-31 22:56:46 +05:30
on_stop: review-docs-cleanup
2019-12-04 20:38:33 +05:30
before_script:
2021-04-29 21:17:54 +05:30
- source ./scripts/utils.sh
- install_gitlab_gem
2019-07-31 22:56:46 +05:30
# 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:
2022-04-04 11:22:00 +05:30
- ./scripts/trigger-build.rb docs deploy
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:
2021-04-29 21:17:54 +05:30
name: review-docs/mr-${CI_MERGE_REQUEST_IID}
2019-07-31 22:56:46 +05:30
action: stop
script:
2022-04-04 11:22:00 +05:30
- ./scripts/trigger-build.rb docs cleanup
2019-07-31 22:56:46 +05:30
2021-01-29 00:20:46 +05:30
docs-lint markdown:
2019-12-04 20:38:33 +05:30
extends:
- .default-retry
2020-03-13 15:44:24 +05:30
- .docs:rules:docs-lint
2021-01-29 00:20:46 +05:30
# When updating the image version here, update it in /scripts/lint-doc.sh too.
2022-10-11 01:57:18 +05:30
image: ${REGISTRY_HOST}/${REGISTRY_GROUP}/gitlab-docs/lint-markdown:alpine-3.16-vale-2.20.1-markdownlint-0.32.2
2021-12-11 22:18:48 +05:30
stage: lint
2020-04-08 14:13:33 +05:30
needs: []
2019-07-31 22:56:46 +05:30
script:
- scripts/lint-doc.sh
2021-01-29 00:20:46 +05:30
docs-lint links:
extends:
- .docs:rules:docs-lint
2022-07-23 23:45:48 +05:30
image: ${REGISTRY_HOST}/${REGISTRY_GROUP}/gitlab-docs/lint-html:alpine-3.16-ruby-2.7.6-0bc327a4
2021-12-11 22:18:48 +05:30
stage: lint
2021-01-29 00:20:46 +05:30
needs: []
script:
2019-12-04 20:38:33 +05:30
# Prepare docs for build
2020-04-08 14:13:33 +05:30
# 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
2019-07-31 22:56:46 +05:30
- cd /tmp/gitlab-docs
# Build HTML from Markdown
- bundle exec nanoc
2021-04-29 21:17:54 +05:30
# Check the internal links and anchors (in parallel)
- "parallel time bundle exec nanoc check ::: internal_links internal_anchors"
2019-12-21 20:55:43 +05:30
2020-07-28 23:09:34 +05:30
ui-docs-links lint:
extends:
- .docs:rules:docs-lint
- .static-analysis-base
2021-12-11 22:18:48 +05:30
- .ruby-cache
stage: lint
2020-07-28 23:09:34 +05:30
needs: []
script:
- bundle exec haml-lint -i DocumentationLinks
2021-12-11 22:18:48 +05:30
2022-03-02 08:16:31 +05:30
docs-lint deprecations-and-removals:
2021-12-11 22:18:48 +05:30
variables:
SETUP_DB: "false"
extends:
- .default-retry
- .rails-cache
- .default-before_script
2022-03-02 08:16:31 +05:30
- .docs:rules:deprecations-and-removals
2021-12-11 22:18:48 +05:30
stage: lint
needs: []
script:
- bundle exec rake gitlab:docs:check_deprecations
2022-03-02 08:16:31 +05:30
- bundle exec rake gitlab:docs:check_removals