From 458caacd5a4c733cc2f719fccdb9dec634f66c0a Mon Sep 17 00:00:00 2001 From: James Upjohn Date: Wed, 23 Dec 2020 18:01:54 +1300 Subject: [PATCH 1/8] Add basic CI using mkdocs --- .github/workflows/docs-build-ci.yaml | 41 ++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 .github/workflows/docs-build-ci.yaml diff --git a/.github/workflows/docs-build-ci.yaml b/.github/workflows/docs-build-ci.yaml new file mode 100644 index 0000000..0b528cc --- /dev/null +++ b/.github/workflows/docs-build-ci.yaml @@ -0,0 +1,41 @@ +name: Build Documentation + +on: + push: + - main + - develop + pull_request: + - main + - develop + +jobs: + pre-build: + name: Setup build environment + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + fetch-depth: 0 + + - name: Setup Python and Pip + uses: actions/setup-python@v2 + with: + path: '.github/workflows' + python-version: '3.x' + + - name: Install MKDocs with plugins + uses: BSFishy/pip-action@v1 + with: + packages: | + mkdocs-material + mkdocs-git-revision-date-localized-plugin + build-docs: + name: Build documentation + runs-on: ubuntu-latest + needs: pre-build + + steps: + - name: Run 'mkdocs build' + run: mkdocs build From 2b236468deefa42340473f6c3f0fcba27dde0115 Mon Sep 17 00:00:00 2001 From: James Upjohn Date: Wed, 23 Dec 2020 18:35:09 +1300 Subject: [PATCH 2/8] Only trigger PR builds on open & synchronize --- .github/workflows/docs-build-ci.yaml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs-build-ci.yaml b/.github/workflows/docs-build-ci.yaml index 0b528cc..54b28de 100644 --- a/.github/workflows/docs-build-ci.yaml +++ b/.github/workflows/docs-build-ci.yaml @@ -5,8 +5,10 @@ on: - main - develop pull_request: - - main - - develop + branches: + - main + - develop + types: [ opened, synchronize ] jobs: pre-build: From b5a0590811192454dcc255879f77a3b5ec16c521 Mon Sep 17 00:00:00 2001 From: James Upjohn Date: Wed, 23 Dec 2020 18:37:02 +1300 Subject: [PATCH 3/8] Add newlines to CI pipeline --- .github/workflows/docs-build-ci.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/docs-build-ci.yaml b/.github/workflows/docs-build-ci.yaml index 54b28de..e0bcf7a 100644 --- a/.github/workflows/docs-build-ci.yaml +++ b/.github/workflows/docs-build-ci.yaml @@ -10,6 +10,7 @@ on: - develop types: [ opened, synchronize ] + jobs: pre-build: name: Setup build environment @@ -33,6 +34,7 @@ jobs: packages: | mkdocs-material mkdocs-git-revision-date-localized-plugin + build-docs: name: Build documentation runs-on: ubuntu-latest From 22d3137f33bea97c49eada6c381c6696c3041ec8 Mon Sep 17 00:00:00 2001 From: James Upjohn Date: Wed, 23 Dec 2020 19:22:17 +1300 Subject: [PATCH 4/8] Update types definition for CI 'on' param --- .github/workflows/docs-build-ci.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs-build-ci.yaml b/.github/workflows/docs-build-ci.yaml index e0bcf7a..427a94b 100644 --- a/.github/workflows/docs-build-ci.yaml +++ b/.github/workflows/docs-build-ci.yaml @@ -8,7 +8,9 @@ on: branches: - main - develop - types: [ opened, synchronize ] + types: + - opened + - synchronize jobs: From ecbb9a64056ecd154edde540b076987b87548183 Mon Sep 17 00:00:00 2001 From: James Upjohn Date: Wed, 23 Dec 2020 19:24:25 +1300 Subject: [PATCH 5/8] Add branches subsection to CI YAML --- .github/workflows/docs-build-ci.yaml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs-build-ci.yaml b/.github/workflows/docs-build-ci.yaml index 427a94b..722dfd5 100644 --- a/.github/workflows/docs-build-ci.yaml +++ b/.github/workflows/docs-build-ci.yaml @@ -2,8 +2,9 @@ name: Build Documentation on: push: - - main - - develop + branches: + - main + - develop pull_request: branches: - main From b7ac2639d0030e002341c2f8a76aed9cf34e8d07 Mon Sep 17 00:00:00 2001 From: James Upjohn Date: Wed, 23 Dec 2020 19:34:55 +1300 Subject: [PATCH 6/8] Reduce 2-job CI action down to 1 --- .github/workflows/docs-build-ci.yaml | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/.github/workflows/docs-build-ci.yaml b/.github/workflows/docs-build-ci.yaml index 722dfd5..d2915d0 100644 --- a/.github/workflows/docs-build-ci.yaml +++ b/.github/workflows/docs-build-ci.yaml @@ -15,8 +15,8 @@ on: jobs: - pre-build: - name: Setup build environment + build-docs: + name: Build documentation runs-on: ubuntu-latest steps: @@ -28,7 +28,6 @@ jobs: - name: Setup Python and Pip uses: actions/setup-python@v2 with: - path: '.github/workflows' python-version: '3.x' - name: Install MKDocs with plugins @@ -38,11 +37,5 @@ jobs: mkdocs-material mkdocs-git-revision-date-localized-plugin - build-docs: - name: Build documentation - runs-on: ubuntu-latest - needs: pre-build - - steps: - name: Run 'mkdocs build' run: mkdocs build From f3b5b0e9a1e6bc7210fb8aadd952a8be26fcf783 Mon Sep 17 00:00:00 2001 From: James Upjohn Date: Wed, 23 Dec 2020 19:37:08 +1300 Subject: [PATCH 7/8] Fix key indentation in mkdocs config --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 867fb3d..a163b9b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,5 +9,5 @@ theme: plugins: - search: - prebuild_index: true + prebuild_index: true - git-revision-date From c7f21ce07f86eadbaad825c5ecc635676aa89b02 Mon Sep 17 00:00:00 2001 From: James Upjohn Date: Wed, 23 Dec 2020 19:38:47 +1300 Subject: [PATCH 8/8] Fix wrong mkdocs plugin being installed by pip --- .github/workflows/docs-build-ci.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs-build-ci.yaml b/.github/workflows/docs-build-ci.yaml index d2915d0..3ad92d8 100644 --- a/.github/workflows/docs-build-ci.yaml +++ b/.github/workflows/docs-build-ci.yaml @@ -35,7 +35,7 @@ jobs: with: packages: | mkdocs-material - mkdocs-git-revision-date-localized-plugin + mkdocs-git-revision-date-plugin - name: Run 'mkdocs build' run: mkdocs build