alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
de5efa53c0
esp-idf/.gitlab/ci/docs.yml

231 lines
6.3 KiB
YAML
Raw Normal View History

docs: add fast build feature and activate it in CI Adds feature for skipping include of doxygen headers into sphinx build when env variable is set. Builds incomplete docs (no function API documention) but speeds up building (20min to 1<min). Add this fast build as the default way of building docs in CI on non protected branches.
2021-04-27 00:24:22 -04:00
.patterns-docs: &patterns-docs
- ".gitlab/ci/docs.yml"
- "docs/**/*"
- "components/**/*.h"
- "components/**/Kconfig*"
- "components/**/CMakeList.txt"
- "components/**/sdkconfig*"
- "tools/kconfig_new/**/*"
- "CONTRIBUTING.rst"
ci: deploy doc previews when .rst files are changed
2021-10-13 06:19:05 -04:00
.patterns-docs-preview: &patterns-docs-preview
- "docs/**/*"
docs: add fast build feature and activate it in CI Adds feature for skipping include of doxygen headers into sphinx build when env variable is set. Builds incomplete docs (no function API documention) but speeds up building (20min to 1<min). Add this fast build as the default way of building docs in CI on non protected branches.
2021-04-27 00:24:22 -04:00
.if-protected: &if-protected
if: '($CI_COMMIT_REF_NAME == "master" || $CI_COMMIT_BRANCH =~ /^release\/v/ || $CI_COMMIT_TAG =~ /^v\d+\.\d+(\.\d+)?($|-)/)'
.if-protected-no_label: &if-protected-no_label
if: '($CI_COMMIT_REF_NAME == "master" || $CI_COMMIT_BRANCH =~ /^release\/v/ || $CI_COMMIT_TAG =~ /^v\d+\.\d+(\.\d+)?($|-)/) && $BOT_TRIGGER_WITH_LABEL == null'
ci: add qa-test-tag rules
2023-10-18 00:55:53 -04:00
.if-qa-test-tag: &if-qa-test-tag
if: '$CI_COMMIT_TAG =~ /^qa-test/'
docs: add fast build feature and activate it in CI Adds feature for skipping include of doxygen headers into sphinx build when env variable is set. Builds incomplete docs (no function API documention) but speeds up building (20min to 1<min). Add this fast build as the default way of building docs in CI on non protected branches.
2021-04-27 00:24:22 -04:00
.if-label-build_docs: &if-label-build_docs
if: '$BOT_LABEL_BUILD_DOCS || $CI_MERGE_REQUEST_LABELS =~ /^(?:[^,\n\r]+,)*build_docs(?:,[^,\n\r]+)*$/i'
.if-label-docs: &if-label-docs
if: '$BOT_LABEL_DOCS || $CI_MERGE_REQUEST_LABELS =~ /^(?:[^,\n\r]+,)*docs(?:,[^,\n\r]+)*$/i'
CI: make full docs build the default
2022-05-18 05:26:08 -04:00
.if-label-docs_fast: &if-label-docs_fast
if: '$BOT_LABEL_DOCS_FAST || $CI_MERGE_REQUEST_LABELS =~ /^(?:[^,\n\r]+,)*docs_fast(?:,[^,\n\r]+)*$/i'
docs: add fast build feature and activate it in CI Adds feature for skipping include of doxygen headers into sphinx build when env variable is set. Builds incomplete docs (no function API documention) but speeds up building (20min to 1<min). Add this fast build as the default way of building docs in CI on non protected branches.
2021-04-27 00:24:22 -04:00
.if-dev-push: &if-dev-push
ci: add qa-test-tag rules
2023-10-18 00:55:53 -04:00
if: '$CI_COMMIT_REF_NAME != "master" && $CI_COMMIT_BRANCH !~ /^release\/v/ && $CI_COMMIT_TAG !~ /^v\d+\.\d+(\.\d+)?($|-)/ && $CI_COMMIT_TAG !~ /^qa-test/ && ($CI_PIPELINE_SOURCE == "push" || $CI_PIPELINE_SOURCE == "merge_request_event")'
docs: add fast build feature and activate it in CI Adds feature for skipping include of doxygen headers into sphinx build when env variable is set. Builds incomplete docs (no function API documention) but speeds up building (20min to 1<min). Add this fast build as the default way of building docs in CI on non protected branches.
2021-04-27 00:24:22 -04:00
.doc-rules:build:docs:
rules:
ci: add qa-test-tag rules
2023-10-18 00:55:53 -04:00
- <<: *if-qa-test-tag
when: never
docs: add fast build feature and activate it in CI Adds feature for skipping include of doxygen headers into sphinx build when env variable is set. Builds incomplete docs (no function API documention) but speeds up building (20min to 1<min). Add this fast build as the default way of building docs in CI on non protected branches.
2021-04-27 00:24:22 -04:00
- <<: *if-protected
- <<: *if-label-build_docs
- <<: *if-label-docs
CI: make full docs build the default
2022-05-18 05:26:08 -04:00
- <<: *if-label-docs_fast
docs: add fast build feature and activate it in CI Adds feature for skipping include of doxygen headers into sphinx build when env variable is set. Builds incomplete docs (no function API documention) but speeds up building (20min to 1<min). Add this fast build as the default way of building docs in CI on non protected branches.
2021-04-27 00:24:22 -04:00
- <<: *if-dev-push
changes: *patterns-docs
ci(docs): Move doc related jobs to docs.yml
2020-11-04 04:07:33 -05:00
# stage: pre_check
check_readme_links:
extends:
ci: simplify the python env to idf venv only
2022-07-28 03:32:13 -04:00
- .pre_check_template
ci(rules): auto generate rules.yml labels titles and rules Also simplified the labels and ci - Remove label regular_test, weekend_test - Remove apply_job_filter - check_submodule_sync: only run on protected branch
2021-02-08 23:31:38 -05:00
tags: ["build", "amd64", "internet"]
ci(docs): Move doc related jobs to docs.yml
2020-11-04 04:07:33 -05:00
allow_failure: true
script:
- python ${IDF_PATH}/tools/ci/check_readme_links.py
check_docs_lang_sync:
extends:
ci: simplify the python env to idf venv only
2022-07-28 03:32:13 -04:00
- .pre_check_template
docs: add fast build feature and activate it in CI Adds feature for skipping include of doxygen headers into sphinx build when env variable is set. Builds incomplete docs (no function API documention) but speeds up building (20min to 1<min). Add this fast build as the default way of building docs in CI on non protected branches.
2021-04-27 00:24:22 -04:00
- .doc-rules:build:docs
ci(docs): Move doc related jobs to docs.yml
2020-11-04 04:07:33 -05:00
script:
- cd docs
- ./check_lang_folder_sync.sh
ci(rules): auto generate rules.yml labels titles and rules Also simplified the labels and ci - Remove label regular_test, weekend_test - Remove apply_job_filter - check_submodule_sync: only run on protected branch
2021-02-08 23:31:38 -05:00
.build_docs_template:
image: $ESP_IDF_DOC_ENV_IMAGE
tags:
- build_docs
dependencies: []
script:
- cd docs
docs: update to use esp-docs
2021-08-23 20:56:48 -04:00
- build-docs -t $DOCTGT -bs $DOC_BUILDERS -l $DOCLANG build
ci(rules): auto generate rules.yml labels titles and rules Also simplified the labels and ci - Remove label regular_test, weekend_test - Remove apply_job_filter - check_submodule_sync: only run on protected branch
2021-02-08 23:31:38 -05:00
parallel:
matrix:
- DOCLANG: ["en", "zh_CN"]
docs: update esp-docs, rename esp8684 to esp32c2
2022-01-20 02:49:48 -05:00
DOCTGT: ["esp32", "esp32s2", "esp32s3", "esp32c3", "esp32c2"]
ci(rules): auto generate rules.yml labels titles and rules Also simplified the labels and ci - Remove label regular_test, weekend_test - Remove apply_job_filter - check_submodule_sync: only run on protected branch
2021-02-08 23:31:38 -05:00
ci(docs): Move doc related jobs to docs.yml
2020-11-04 04:07:33 -05:00
check_docs_gh_links:
ci: only run check_docs_gh_links job once per pipeline Job simply walks all .rst files and check links. No need to run for multiple targets/languages
2021-06-30 01:30:13 -04:00
image: $ESP_IDF_DOC_ENV_IMAGE
ci(docs): Move doc related jobs to docs.yml
2020-11-04 04:07:33 -05:00
extends:
ci: simplify the python env to idf venv only
2022-07-28 03:32:13 -04:00
- .pre_check_template
docs: add fast build feature and activate it in CI Adds feature for skipping include of doxygen headers into sphinx build when env variable is set. Builds incomplete docs (no function API documention) but speeds up building (20min to 1<min). Add this fast build as the default way of building docs in CI on non protected branches.
2021-04-27 00:24:22 -04:00
- .doc-rules:build:docs
ci(docs): Move doc related jobs to docs.yml
2020-11-04 04:07:33 -05:00
script:
- cd docs
docs: update to use esp-docs
2021-08-23 20:56:48 -04:00
- build-docs gh-linkcheck
ci(docs): Move doc related jobs to docs.yml
2020-11-04 04:07:33 -05:00
ci: move doc build jobs into build_doc stage to run in parallel
2021-02-08 23:51:28 -05:00
# stage: build_doc
# Add this stage to let the build_docs job run in parallel with build
ci(docs): Move doc related jobs to docs.yml
2020-11-04 04:07:33 -05:00
.build_docs_build_stage_template:
extends:
- .build_docs_template
ci: move doc build jobs into build_doc stage to run in parallel
2021-02-08 23:51:28 -05:00
stage: build_doc
ci(docs): Move doc related jobs to docs.yml
2020-11-04 04:07:33 -05:00
needs:
ci(rules): auto generate rules.yml labels titles and rules Also simplified the labels and ci - Remove label regular_test, weekend_test - Remove apply_job_filter - check_submodule_sync: only run on protected branch
2021-02-08 23:31:38 -05:00
- job: check_docs_lang_sync
artifacts: false
- job: check_docs_gh_links
artifacts: false
ci(docs): Move doc related jobs to docs.yml
2020-11-04 04:07:33 -05:00
docs: add fast build feature and activate it in CI Adds feature for skipping include of doxygen headers into sphinx build when env variable is set. Builds incomplete docs (no function API documention) but speeds up building (20min to 1<min). Add this fast build as the default way of building docs in CI on non protected branches.
2021-04-27 00:24:22 -04:00
# Doc jobs have a lot of special cases, we specify rules here directly instead
# in dependencies.yml to simplify things
build_docs_html_full:
ci(docs): Move doc related jobs to docs.yml
2020-11-04 04:07:33 -05:00
extends:
- .build_docs_build_stage_template
docs: add fast build feature and activate it in CI Adds feature for skipping include of doxygen headers into sphinx build when env variable is set. Builds incomplete docs (no function API documention) but speeds up building (20min to 1<min). Add this fast build as the default way of building docs in CI on non protected branches.
2021-04-27 00:24:22 -04:00
rules:
CI: make full docs build the default
2022-05-18 05:26:08 -04:00
- <<: *if-label-docs_fast
when: never
docs: add fast build feature and activate it in CI Adds feature for skipping include of doxygen headers into sphinx build when env variable is set. Builds incomplete docs (no function API documention) but speeds up building (20min to 1<min). Add this fast build as the default way of building docs in CI on non protected branches.
2021-04-27 00:24:22 -04:00
- <<: *if-protected
CI: make full docs build the default
2022-05-18 05:26:08 -04:00
- <<: *if-label-build_docs
- <<: *if-label-docs
- <<: *if-dev-push
changes: *patterns-docs
ci(docs): Move doc related jobs to docs.yml
2020-11-04 04:07:33 -05:00
artifacts:
when: always
paths:
- docs/_build/*/*/*.txt
- docs/_build/*/*/html/*
expire_in: 4 days
variables:
DOC_BUILDERS: "html"
docs: add fast build feature and activate it in CI Adds feature for skipping include of doxygen headers into sphinx build when env variable is set. Builds incomplete docs (no function API documention) but speeds up building (20min to 1<min). Add this fast build as the default way of building docs in CI on non protected branches.
2021-04-27 00:24:22 -04:00
build_docs_html_fast:
extends:
- .build_docs_build_stage_template
rules:
CI: make full docs build the default
2022-05-18 05:26:08 -04:00
- <<: *if-label-docs_fast
docs: add fast build feature and activate it in CI Adds feature for skipping include of doxygen headers into sphinx build when env variable is set. Builds incomplete docs (no function API documention) but speeds up building (20min to 1<min). Add this fast build as the default way of building docs in CI on non protected branches.
2021-04-27 00:24:22 -04:00
artifacts:
when: always
paths:
- docs/_build/*/*/*.txt
- docs/_build/*/*/html/*
expire_in: 4 days
variables:
DOC_BUILDERS: "html"
DOCS_FAST_BUILD: "yes"
ci(docs): Move doc related jobs to docs.yml
2020-11-04 04:07:33 -05:00
build_docs_pdf:
extends:
- .build_docs_build_stage_template
docs: add fast build feature and activate it in CI Adds feature for skipping include of doxygen headers into sphinx build when env variable is set. Builds incomplete docs (no function API documention) but speeds up building (20min to 1<min). Add this fast build as the default way of building docs in CI on non protected branches.
2021-04-27 00:24:22 -04:00
rules:
CI: make full docs build the default
2022-05-18 05:26:08 -04:00
- <<: *if-label-docs_fast
when: never
docs: add fast build feature and activate it in CI Adds feature for skipping include of doxygen headers into sphinx build when env variable is set. Builds incomplete docs (no function API documention) but speeds up building (20min to 1<min). Add this fast build as the default way of building docs in CI on non protected branches.
2021-04-27 00:24:22 -04:00
- <<: *if-protected
CI: make full docs build the default
2022-05-18 05:26:08 -04:00
- <<: *if-label-build_docs
- <<: *if-label-docs
- <<: *if-dev-push
changes: *patterns-docs
ci(docs): Move doc related jobs to docs.yml
2020-11-04 04:07:33 -05:00
artifacts:
when: always
paths:
- docs/_build/*/*/latex/*
expire_in: 4 days
variables:
DOC_BUILDERS: "latex"
.deploy_docs_template:
image: $ESP_IDF_DOC_ENV_IMAGE
Drop support for unsupported Python versions
2021-05-26 04:44:20 -04:00
variables:
ci: fix redundant key `variables` under `.deploy_docs_template`
2021-12-06 00:36:21 -05:00
DOCS_BUILD_DIR: "${IDF_PATH}/docs/_build/"
PYTHONUNBUFFERED: 1
ci(rules): auto generate rules.yml labels titles and rules Also simplified the labels and ci - Remove label regular_test, weekend_test - Remove apply_job_filter - check_submodule_sync: only run on protected branch
2021-02-08 23:31:38 -05:00
stage: test_deploy
ci(docs): Move doc related jobs to docs.yml
2020-11-04 04:07:33 -05:00
tags:
- deploy
- shiny
script:
- add_doc_server_ssh_keys $DOCS_DEPLOY_PRIVATEKEY $DOCS_DEPLOY_SERVER $DOCS_DEPLOY_SERVER_USER
ci: fix using HEAD and SHA with merged result pipelines
2021-10-28 00:07:02 -04:00
- export GIT_VER=$(git describe --always ${PIPELINE_COMMIT_SHA} --)
docs: update to use esp-docs
2021-08-23 20:56:48 -04:00
- deploy-docs
ci(docs): Move doc related jobs to docs.yml
2020-11-04 04:07:33 -05:00
# stage: test_deploy
deploy_docs_preview:
extends:
- .deploy_docs_template
docs: add fast build feature and activate it in CI Adds feature for skipping include of doxygen headers into sphinx build when env variable is set. Builds incomplete docs (no function API documention) but speeds up building (20min to 1<min). Add this fast build as the default way of building docs in CI on non protected branches.
2021-04-27 00:24:22 -04:00
rules:
- <<: *if-label-build_docs
- <<: *if-label-docs
ci: deploy doc previews when .rst files are changed
2021-10-13 06:19:05 -04:00
- <<: *if-dev-push
changes: *patterns-docs-preview
ci: deploy to preview as soon as build doc jobs are done
2022-03-25 04:18:54 -04:00
needs:
- job: build_docs_html_fast
optional: true
- job: build_docs_html_full
optional: true
- job: build_docs_pdf
optional: true
ci(docs): Move doc related jobs to docs.yml
2020-11-04 04:07:33 -05:00
variables:
TYPE: "preview"
# older branches use DOCS_DEPLOY_KEY, DOCS_SERVER, DOCS_SERVER_USER, DOCS_PATH for preview server so we keep these names for 'preview'
DOCS_DEPLOY_PRIVATEKEY: "$DOCS_DEPLOY_KEY"
DOCS_DEPLOY_SERVER: "$DOCS_SERVER"
DOCS_DEPLOY_SERVER_USER: "$DOCS_SERVER_USER"
DOCS_DEPLOY_PATH: "$DOCS_PATH"
ci: update docs preview url
2021-10-13 04:03:14 -04:00
DOCS_DEPLOY_URL_BASE: "https://$DOCS_PREVIEW_SERVER_URL/docs/esp-idf"
ci(docs): Move doc related jobs to docs.yml
2020-11-04 04:07:33 -05:00
# stage: post_deploy
deploy_docs_production:
# The DOCS_PROD_* variables used by this job are "Protected" so these branches must all be marked "Protected" in Gitlab settings
extends:
- .deploy_docs_template
docs: add fast build feature and activate it in CI Adds feature for skipping include of doxygen headers into sphinx build when env variable is set. Builds incomplete docs (no function API documention) but speeds up building (20min to 1<min). Add this fast build as the default way of building docs in CI on non protected branches.
2021-04-27 00:24:22 -04:00
rules:
- <<: *if-protected-no_label
ci(docs): Move doc related jobs to docs.yml
2020-11-04 04:07:33 -05:00
stage: post_deploy
ci(rules): auto generate rules.yml labels titles and rules Also simplified the labels and ci - Remove label regular_test, weekend_test - Remove apply_job_filter - check_submodule_sync: only run on protected branch
2021-02-08 23:31:38 -05:00
dependencies: # set dependencies to null to avoid missing artifacts issue
ci(docs): Move doc related jobs to docs.yml
2020-11-04 04:07:33 -05:00
needs: # ensure runs after push_to_github succeeded
docs: add fast build feature and activate it in CI Adds feature for skipping include of doxygen headers into sphinx build when env variable is set. Builds incomplete docs (no function API documention) but speeds up building (20min to 1<min). Add this fast build as the default way of building docs in CI on non protected branches.
2021-04-27 00:24:22 -04:00
- build_docs_html_full
ci(docs): Move doc related jobs to docs.yml
2020-11-04 04:07:33 -05:00
- build_docs_pdf
ci(rules): auto generate rules.yml labels titles and rules Also simplified the labels and ci - Remove label regular_test, weekend_test - Remove apply_job_filter - check_submodule_sync: only run on protected branch
2021-02-08 23:31:38 -05:00
- job: push_to_github
artifacts: false
ci(docs): Move doc related jobs to docs.yml
2020-11-04 04:07:33 -05:00
variables:
TYPE: "preview"
DOCS_DEPLOY_PRIVATEKEY: "$DOCS_PROD_DEPLOY_KEY"
DOCS_DEPLOY_SERVER: "$DOCS_PROD_SERVER"
DOCS_DEPLOY_SERVER_USER: "$DOCS_PROD_SERVER_USER"
DOCS_DEPLOY_PATH: "$DOCS_PROD_PATH"
DOCS_DEPLOY_URL_BASE: "https://docs.espressif.com/projects/esp-idf"
docs: update docs to be able to build with esp8684
2021-11-09 04:11:01 -05:00
DEPLOY_STABLE: 1
ci(docs): Move doc related jobs to docs.yml
2020-11-04 04:07:33 -05:00
check_doc_links:
extends:
- .build_docs_template
- .rules:protected
stage: post_deploy
tags: ["build", "amd64", "internet"]
artifacts:
when: always
paths:
- docs/_build/*/*/*.txt
- docs/_build/*/*/linkcheck/*.txt
expire_in: 1 week
allow_failure: true
script:
- cd docs
docs: update linkcheck configs linkcheck CI job can now pass, no longer necessary to ignore the results from it.
2022-04-28 03:59:03 -04:00
- build-docs -t $DOCTGT -l $DOCLANG linkcheck
Reference in New Issue Copy Permalink