From be7f465306490be7c23cfcaba131ef5147e2ea25 Mon Sep 17 00:00:00 2001 From: Marius Vikhammer Date: Wed, 18 May 2022 17:26:08 +0800 Subject: [PATCH] CI: make full docs build the default --- .gitlab/ci/README.md | 2 +- .gitlab/ci/docs.yml | 27 ++++++++++++++++----------- 2 files changed, 17 insertions(+), 12 deletions(-) diff --git a/.gitlab/ci/README.md b/.gitlab/ci/README.md index cbbce82dcd..8d16af11e6 100644 --- a/.gitlab/ci/README.md +++ b/.gitlab/ci/README.md @@ -45,7 +45,7 @@ - `custom_test[_esp32/esp32s2/...]` - `docker` - `docs` -- `docs_full`, triggers a full docs build, not a fast build which is the CI default. This includes PDF and doxygen generated API documentation. +- `docs_fast`, triggers a fast docs build, not a full build which is the CI default. This skips PDF build as well as doxygen APIs, reducing the build time by 90+%. - `example_test[_esp32/esp32s2/...]` - `fuzzer_test` - `host_test` diff --git a/.gitlab/ci/docs.yml b/.gitlab/ci/docs.yml index 82db74e9c4..1b9674d6d6 100644 --- a/.gitlab/ci/docs.yml +++ b/.gitlab/ci/docs.yml @@ -23,8 +23,8 @@ .if-label-docs: &if-label-docs if: '$BOT_LABEL_DOCS || $CI_MERGE_REQUEST_LABELS =~ /^(?:[^,\n\r]+,)*docs(?:,[^,\n\r]+)*$/i' -.if-label-docs_full: &if-label-docs_full - if: '$BOT_LABEL_DOCS_FULL || $CI_MERGE_REQUEST_LABELS =~ /^(?:[^,\n\r]+,)*docs_full(?:,[^,\n\r]+)*$/i' +.if-label-docs_fast: &if-label-docs_fast + if: '$BOT_LABEL_DOCS_FAST || $CI_MERGE_REQUEST_LABELS =~ /^(?:[^,\n\r]+,)*docs_fast(?:,[^,\n\r]+)*$/i' .if-dev-push: &if-dev-push if: '$CI_COMMIT_REF_NAME != "master" && $CI_COMMIT_BRANCH !~ /^release\/v/ && $CI_COMMIT_TAG !~ /^v\d+\.\d+(\.\d+)?($|-)/ && ($CI_PIPELINE_SOURCE == "push" || $CI_PIPELINE_SOURCE == "merge_request_event")' @@ -34,7 +34,7 @@ - <<: *if-protected - <<: *if-label-build_docs - <<: *if-label-docs - - <<: *if-label-docs_full + - <<: *if-label-docs_fast - <<: *if-dev-push changes: *patterns-docs @@ -101,8 +101,13 @@ build_docs_html_full: extends: - .build_docs_build_stage_template rules: + - <<: *if-label-docs_fast + when: never - <<: *if-protected - - <<: *if-label-docs_full + - <<: *if-label-build_docs + - <<: *if-label-docs + - <<: *if-dev-push + changes: *patterns-docs artifacts: when: always paths: @@ -116,12 +121,7 @@ build_docs_html_fast: extends: - .build_docs_build_stage_template rules: - - <<: *if-label-docs_full - when: never - - <<: *if-label-build_docs - - <<: *if-label-docs - - <<: *if-dev-push - changes: *patterns-docs + - <<: *if-label-docs_fast artifacts: when: always paths: @@ -136,8 +136,13 @@ build_docs_pdf: extends: - .build_docs_build_stage_template rules: + - <<: *if-label-docs_fast + when: never - <<: *if-protected - - <<: *if-label-docs_full + - <<: *if-label-build_docs + - <<: *if-label-docs + - <<: *if-dev-push + changes: *patterns-docs artifacts: when: always paths: