From 3ac2120f817860001518169c2603bfa65d9eb5dd Mon Sep 17 00:00:00 2001 From: mfeix Date: Wed, 11 Aug 2021 16:04:06 +0200 Subject: [PATCH] feat(Docker-Compose): Add Validity Template and Pages Template to Documentation --- .gitlab-ci.yml | 53 +++++++++----------------------- tool-documentation.gitlab-ci.yml | 27 +++++++++++++--- 2 files changed, 37 insertions(+), 43 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index e89f84c..3fa8d52 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -4,10 +4,8 @@ stages: - release include: - - project: 'gilden/ci/gitlab-ci-templates' - ref: 'master' - file: - - 'release-template.gitlab-ci.yml' + - local: 'release-template.gitlab-ci.yml' + - local: 'tool-documentation.gitlab-ci.yml' Test-Java-Backend: stage: test @@ -19,57 +17,37 @@ Test-Java-Backend: project: gilden/ci/java-backend-template strategy: depend -.generate-document: - image: gitlab.exxcellent.de:4567/gilden/ci/exxcellent-documentation-tool:latest - stage: generate-docs +check_confluence_validity: variables: DOCUMENT_ROOT: "documentation" INPUT_FILE: "document.adoc" IMAGES_DIR: images - OUTPUT_DIR: tmp - PRINT_TOC: "true" CREATE_SUB_PAGES: "false" - REMOVE_ORPHANS: "true" - COMPACT_CHAPTER_LABELS: "true" PAGE_PREFIX: "[CI/CD] - [TMPL] - " CONFLUENCE_SPACE: RANDI - REV_NUMBER: $CI_COMMIT_SHORT_SHA TEXT_GENERATED_HINT: 'This is a generated page, do not edit! All changes must happen in the Repository -.' + .' FILE_INPUT: "index.html,111183157,gitlab-ci-templates" - before_script: - - generate --type html - - generate --type pdf - -check_confluence_validity: - extends: .generate-document - stage: generate-docs - variables: - OUTPUT_DIR: "merge_requests" - script: - - check-validity - artifacts: - paths: [ merge_requests/ ] - only: [ merge_requests ] + extends: .check_confluence_validity-template pages: - extends: .generate-document - stage: generate-docs variables: - OUTPUT_DIR: "public" - script: - - publish - artifacts: - paths: [ public/ ] - only: [ master ] - + DOCUMENT_ROOT: "documentation" + INPUT_FILE: "document.adoc" + IMAGES_DIR: images + CREATE_SUB_PAGES: "false" + PAGE_PREFIX: "[CI/CD] - [TMPL] - " + CONFLUENCE_SPACE: RANDI + TEXT_GENERATED_HINT: 'This is a generated page, do not edit! All changes must happen in the Repository + .' + FILE_INPUT: "index.html,111183157,gitlab-ci-templates" + extends: .pages-template .release-template: trigger: include: pipelines/update-version-pipeline.gitlab-ci.yml strategy: depend - a.major-release: extends: .release-template variables: @@ -94,4 +72,3 @@ e.build-release: extends: .release-template variables: BUMP_VERSION: "build" - diff --git a/tool-documentation.gitlab-ci.yml b/tool-documentation.gitlab-ci.yml index f0b3cb4..cf5ec08 100644 --- a/tool-documentation.gitlab-ci.yml +++ b/tool-documentation.gitlab-ci.yml @@ -1,4 +1,4 @@ -.pages-template: +.documentation-tool-template: image: gitlab.exxcellent.de:4567/gilden/ci/exxcellent-documentation-tool:latest variables: DOCUMENT_ROOT: . @@ -15,13 +15,30 @@ COMPACT_CHAPTER_LABELS: "true" PAGE_PREFIX: "" PAGE_SUFFIX: "" - before_script: [ ] - script: + before_script: - generate --type html - generate --type pdf + +.check_confluence_validity-template: + extends: .documentation-tool-template + stage: generate-docs + variables: + OUTPUT_DIR: merge_requests + script: + - check-validity + artifacts: + paths: [ merge_requests/ ] + rules: + - if: '$CI_PIPELINE_SOURCE == "merge_request_event"' + +.pages-template: + extends: .documentation-tool-template + stage: generate-docs + variables: + OUTPUT_DIR: public + script: - publish artifacts: paths: [ public/ ] rules: - - when: manual - + - if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH