espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-04 13:14:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

CI: make full docs build the default

Browse Source
This commit is contained in:
Marius Vikhammer
2022-05-18 17:26:08 +08:00
parent 3bf6e06a80
commit be7f465306
2 changed files with 17 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.gitlab/ci/README.md
View File

@@ -45,7 +45,7 @@
- `custom_test[_esp32/esp32s2/...]` - `custom_test[_esp32/esp32s2/...]`
- `docker` - `docker`
- `docs` - `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/...]` - `example_test[_esp32/esp32s2/...]`
- `fuzzer_test` - `fuzzer_test`
- `host_test` - `host_test`

27
.gitlab/ci/docs.yml
View File

@@ -23,8 +23,8 @@
.if-label-docs: &if-label-docs .if-label-docs: &if-label-docs
if: '$BOT_LABEL_DOCS || $CI_MERGE_REQUEST_LABELS =~ /^(?:[^,\n\r]+,)*docs(?:,[^,\n\r]+)*$/i' if: '$BOT_LABEL_DOCS || $CI_MERGE_REQUEST_LABELS =~ /^(?:[^,\n\r]+,)*docs(?:,[^,\n\r]+)*$/i'
.if-label-docs_full: &if-label-docs_full .if-label-docs_fast: &if-label-docs_fast
if: '$BOT_LABEL_DOCS_FULL || $CI_MERGE_REQUEST_LABELS =~ /^(?:[^,\n\r]+,)*docs_full(?:,[^,\n\r]+)*$/i' if: '$BOT_LABEL_DOCS_FAST || $CI_MERGE_REQUEST_LABELS =~ /^(?:[^,\n\r]+,)*docs_fast(?:,[^,\n\r]+)*$/i'
.if-dev-push: &if-dev-push .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")' 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-protected
- <<: *if-label-build_docs - <<: *if-label-build_docs
- <<: *if-label-docs - <<: *if-label-docs
- <<: *if-label-docs_full - <<: *if-label-docs_fast
- <<: *if-dev-push - <<: *if-dev-push
changes: *patterns-docs changes: *patterns-docs
@@ -101,8 +101,13 @@ build_docs_html_full:
extends: extends:
- .build_docs_build_stage_template - .build_docs_build_stage_template
rules: rules:
- <<: *if-label-docs_fast
when: never
- <<: *if-protected - <<: *if-protected
- <<: *if-label-docs_full - <<: *if-label-build_docs
- <<: *if-label-docs
- <<: *if-dev-push
changes: *patterns-docs
artifacts: artifacts:
when: always when: always
paths: paths:
@@ -116,12 +121,7 @@ build_docs_html_fast:
extends: extends:
- .build_docs_build_stage_template - .build_docs_build_stage_template
rules: rules:
- <<: *if-label-docs_full - <<: *if-label-docs_fast
when: never
- <<: *if-label-build_docs
- <<: *if-label-docs
- <<: *if-dev-push
changes: *patterns-docs
artifacts: artifacts:
when: always when: always
paths: paths:
@@ -136,8 +136,13 @@ build_docs_pdf:
extends: extends:
- .build_docs_build_stage_template - .build_docs_build_stage_template
rules: rules:
- <<: *if-label-docs_fast
when: never
- <<: *if-protected - <<: *if-protected
- <<: *if-label-docs_full - <<: *if-label-build_docs
- <<: *if-label-docs
- <<: *if-dev-push
changes: *patterns-docs
artifacts: artifacts:
when: always when: always
paths: paths: