feat(build): initial add of mkdocs build job

builds a mkdocs static pages using the repositories requirements.txt
for extensions and ONLY if a mkdocs.yml file is present in the root directory
of the repository.

MR !15 #15
This commit is contained in:
2022-01-23 10:31:14 +09:30
parent 954aa28dbf
commit 50b5e8542b

View File

@ -1,20 +1,27 @@
Static Pages: .MKDocs_Build:
image: python:3.7.5-buster image: python:3.7.5-buster
stage: build stage: build
variables: variables:
GIT_DEPTH: 0 GIT_DEPTH: 0
MKDOCS_VERSION: "==1.2.3"
MKDOCS_BUILD_PATH: build
# MKDOCS_INCLUDE_SOURCE: "NO" optional to specify yes
MKDOCS_SOURCE_PATH: pages
before_script: before_script:
- pip install --upgrade pip -r requirements.txt - mkdir -p "$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/$CI_JOB_NAME"
- if [ ! -f "requirements.txt" ]; then pip install --upgrade pip mkdocs$MKDOCS_VERSION; fi
- if [ -f "requirements.txt" ]; then pip install --upgrade pip mkdocs$MKDOCS_VERSION -r requirements.txt; fi
script: script:
# - mkdir static
# - cp README.md pages/
- mkdocs build --clean --strict - mkdocs build --clean --strict
- rm build/sitemap* - mv "$MKDOCS_BUILD_PATH" "$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/$CI_JOB_NAME/$MKDOCS_BUILD_PATH"
- if [ "0$MKDOCS_INCLUDE_SOURCE" != "0" ]; then cp $MKDOCS_SOURCE_PATH "$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/$CI_JOB_NAME/$MKDOCS_SOURCE_PATH"; fi
- ls -laR "$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/$CI_JOB_NAME"
artifacts: artifacts:
paths: paths:
- build - "$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/$CI_JOB_NAME"
rules: rules:
- if: '$CI_COMMIT_BRANCH' - if: '$CI_COMMIT_BRANCH'
when: always exists:
- "mkdocs.yml"
- when: never - when: never