From 7442d65b39af4320d1441e5261541f17faf7af49 Mon Sep 17 00:00:00 2001 From: Phil Ewels Date: Wed, 19 Mar 2025 23:21:15 +0100 Subject: [PATCH 1/6] Docs: Deploy master as 'development' version --- .github/workflows/docs-dev.yml | 33 +++++++++++++++++++ .../{release-docs.yml => docs-release.yml} | 0 2 files changed, 33 insertions(+) create mode 100644 .github/workflows/docs-dev.yml rename .github/workflows/{release-docs.yml => docs-release.yml} (100%) diff --git a/.github/workflows/docs-dev.yml b/.github/workflows/docs-dev.yml new file mode 100644 index 000000000..4a1b544e3 --- /dev/null +++ b/.github/workflows/docs-dev.yml @@ -0,0 +1,33 @@ +name: Publish docs [dev] + +on: + release: + types: [published] + push: + branches: [master] + +permissions: + contents: write + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - uses: actions/setup-python@v5 + with: + python-version: 3.10.6 + + - name: Install Dependencies + run: pip install -r requirements.txt + + - name: Configure git + run: | + git config user.name "github-actions[bot]" + git config user.email "41898282+github-actions[bot]@users.noreply.github.com" + + - name: Build Docs Website + run: mike deploy --alias-type copy development diff --git a/.github/workflows/release-docs.yml b/.github/workflows/docs-release.yml similarity index 100% rename from .github/workflows/release-docs.yml rename to .github/workflows/docs-release.yml From 272d204789c2304726e7a72877d2b07a2822198c Mon Sep 17 00:00:00 2001 From: Phil Ewels Date: Wed, 19 Mar 2025 23:26:37 +0100 Subject: [PATCH 2/6] Missed the --push --- .github/workflows/docs-dev.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs-dev.yml b/.github/workflows/docs-dev.yml index 4a1b544e3..85d279951 100644 --- a/.github/workflows/docs-dev.yml +++ b/.github/workflows/docs-dev.yml @@ -30,4 +30,4 @@ jobs: git config user.email "41898282+github-actions[bot]@users.noreply.github.com" - name: Build Docs Website - run: mike deploy --alias-type copy development + run: mike deploy --push --alias-type copy development From 8d6e17d08856f94aef3bec7169e7f52db5ab0827 Mon Sep 17 00:00:00 2001 From: Phil Ewels Date: Wed, 19 Mar 2025 23:33:07 +0100 Subject: [PATCH 3/6] Rename to _dev to sort to the bottom --- .github/workflows/docs-dev.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs-dev.yml b/.github/workflows/docs-dev.yml index 85d279951..0943bf0c5 100644 --- a/.github/workflows/docs-dev.yml +++ b/.github/workflows/docs-dev.yml @@ -30,4 +30,4 @@ jobs: git config user.email "41898282+github-actions[bot]@users.noreply.github.com" - name: Build Docs Website - run: mike deploy --push --alias-type copy development + run: mike deploy --push --alias-type copy --update-aliases _dev development From 044e1ab3cb75653dba610699c0f308ab9b7d9c7d Mon Sep 17 00:00:00 2001 From: Phil Ewels Date: Wed, 19 Mar 2025 23:35:23 +0100 Subject: [PATCH 4/6] Standardise GitHub action names and filenames --- ...{devcontainer-build-and-push.yml => docker-devcontainer.yml} | 2 +- .github/workflows/{mkdocs-docker.yml => docker-mkdocs.yml} | 2 +- .github/workflows/precommit.yml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) rename .github/workflows/{devcontainer-build-and-push.yml => docker-devcontainer.yml} (98%) rename .github/workflows/{mkdocs-docker.yml => docker-mkdocs.yml} (96%) diff --git a/.github/workflows/devcontainer-build-and-push.yml b/.github/workflows/docker-devcontainer.yml similarity index 98% rename from .github/workflows/devcontainer-build-and-push.yml rename to .github/workflows/docker-devcontainer.yml index f495cc115..124ad14c7 100644 --- a/.github/workflows/devcontainer-build-and-push.yml +++ b/.github/workflows/docker-devcontainer.yml @@ -2,7 +2,7 @@ # - Only pushes if push or release # - Builds without push for PRs to check the Dockerfile -name: Docker image +name: Build Docker [devcontainers] on: pull_request: # Build, don't push diff --git a/.github/workflows/mkdocs-docker.yml b/.github/workflows/docker-mkdocs.yml similarity index 96% rename from .github/workflows/mkdocs-docker.yml rename to .github/workflows/docker-mkdocs.yml index 7e9ca7390..6cdfaf17f 100644 --- a/.github/workflows/mkdocs-docker.yml +++ b/.github/workflows/docker-mkdocs.yml @@ -1,6 +1,6 @@ # Build and push the Docker image for building the site (mkdocs material) -name: MkDocs image +name: Build Docker [MkDocs] on: pull_request: diff --git a/.github/workflows/precommit.yml b/.github/workflows/precommit.yml index 02801e8e8..c086ddb39 100644 --- a/.github/workflows/precommit.yml +++ b/.github/workflows/precommit.yml @@ -1,4 +1,4 @@ -name: Pre-commit checks +name: Code checks [pre-commit] on: push: From 3bfae06fc535c618db580788fbc3953ae1aa4753 Mon Sep 17 00:00:00 2001 From: Phil Ewels Date: Thu, 20 Mar 2025 00:03:15 +0100 Subject: [PATCH 5/6] Try 0.dev --- .github/workflows/docs-dev.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs-dev.yml b/.github/workflows/docs-dev.yml index 0943bf0c5..f56410b7b 100644 --- a/.github/workflows/docs-dev.yml +++ b/.github/workflows/docs-dev.yml @@ -30,4 +30,4 @@ jobs: git config user.email "41898282+github-actions[bot]@users.noreply.github.com" - name: Build Docs Website - run: mike deploy --push --alias-type copy --update-aliases _dev development + run: mike deploy --push --alias-type copy --update-aliases 0.dev development From ced82043b6853a6f49729907e080a66a36576fd7 Mon Sep 17 00:00:00 2001 From: Phil Ewels Date: Thu, 20 Mar 2025 00:05:49 +0100 Subject: [PATCH 6/6] Update path filter --- .github/workflows/docker-devcontainer.yml | 2 +- .github/workflows/docker-mkdocs.yml | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docker-devcontainer.yml b/.github/workflows/docker-devcontainer.yml index 124ad14c7..aa43fc620 100644 --- a/.github/workflows/docker-devcontainer.yml +++ b/.github/workflows/docker-devcontainer.yml @@ -8,7 +8,7 @@ on: pull_request: # Build, don't push paths: - ".devcontainer/**" - - ".github/workflows/devcontainer-build-and-push.yml" + - ".github/workflows/docker-devcontainer.yml" push: { branches: [master] } # Build + push ('latest' tag) release: { types: [published] } # Build + push (release tag) workflow_dispatch: # Build + push (custom tag) diff --git a/.github/workflows/docker-mkdocs.yml b/.github/workflows/docker-mkdocs.yml index 6cdfaf17f..acb0c2c87 100644 --- a/.github/workflows/docker-mkdocs.yml +++ b/.github/workflows/docker-mkdocs.yml @@ -6,6 +6,7 @@ on: pull_request: paths: - ".github/mkdocs.Dockerfile" + - ".github/workflows/docker-mkdocs.yml" - "requirements.txt" push: branches: [master]