From 9101eaa91e125603b08cc9f9d46658b864666c80 Mon Sep 17 00:00:00 2001 From: eladyn <59307989+eladyn@users.noreply.github.com> Date: Tue, 14 Nov 2023 01:41:14 +0100 Subject: [PATCH 1/5] switch to github actions for pages --- .github/workflows/docs.yml | 68 ++++++++++++++++++++++++++------------ 1 file changed, 46 insertions(+), 22 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 31ac58ae..45be3c8e 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,32 +1,56 @@ name: Continuous Integration - Docs on: + # Runs on pushes targeting the default branch push: - branches: - - master - paths: - - .github/workflows/docs.yml - - "docs/**" + branches: ["master"] + + # Allows you to run this workflow manually from the Actions tab workflow_dispatch: +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + jobs: - deploy: - runs-on: ubuntu-18.04 + # Build job + build: + runs-on: ubuntu-latest + env: + MDBOOK_VERSION: 0.4.21 steps: - - name: Checkout sources - uses: actions/checkout@v2 - - - name: Setup mdBook - uses: peaceiris/actions-mdbook@v1 + - uses: actions/checkout@v3 + - name: Install mdBook + run: | + curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh + rustup update + cargo install --version ${MDBOOK_VERSION} mdbook + - name: Setup Pages + id: pages + uses: actions/configure-pages@v3 + - name: Build with mdBook + run: mdbook build + - name: Upload artifact + uses: actions/upload-pages-artifact@v2 with: - mdbook-version: '0.4.2' + path: ./book - - name: Build book - run: mdbook build ./docs - - - name: Deploy on gh-pages - uses: peaceiris/actions-gh-pages@v3 - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./docs/book - cname: docs.spotifyd.rs + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2 From 9d6fa8a36b3b7f59e3ec1f53a17eb4300ad4ade6 Mon Sep 17 00:00:00 2001 From: eladyn <59307989+eladyn@users.noreply.github.com> Date: Tue, 14 Nov 2023 01:42:50 +0100 Subject: [PATCH 2/5] correct path --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 45be3c8e..38564976 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -41,7 +41,7 @@ jobs: - name: Upload artifact uses: actions/upload-pages-artifact@v2 with: - path: ./book + path: ./docs # Deployment job deploy: From d0a5627ebad112cd4308f909b4a661fa7dbdcdb8 Mon Sep 17 00:00:00 2001 From: eladyn <59307989+eladyn@users.noreply.github.com> Date: Tue, 14 Nov 2023 01:44:10 +0100 Subject: [PATCH 3/5] add paths condition --- .github/workflows/docs.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 38564976..e3e03602 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -4,6 +4,9 @@ on: # Runs on pushes targeting the default branch push: branches: ["master"] + paths: + - .github/workflows/docs.yml + - docs/** # Allows you to run this workflow manually from the Actions tab workflow_dispatch: From 1a755b4b598a2c84e79c58f6da113cddf55d8917 Mon Sep 17 00:00:00 2001 From: eladyn <59307989+eladyn@users.noreply.github.com> Date: Tue, 14 Nov 2023 01:49:37 +0100 Subject: [PATCH 4/5] correct paths --- .github/workflows/docs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index e3e03602..0d3bfc7d 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -40,11 +40,11 @@ jobs: id: pages uses: actions/configure-pages@v3 - name: Build with mdBook - run: mdbook build + run: mdbook build ./docs - name: Upload artifact uses: actions/upload-pages-artifact@v2 with: - path: ./docs + path: ./ # Deployment job deploy: From db371393fca9cf76db91d137bdde5dc9309515b6 Mon Sep 17 00:00:00 2001 From: eladyn <59307989+eladyn@users.noreply.github.com> Date: Tue, 14 Nov 2023 01:54:18 +0100 Subject: [PATCH 5/5] fix path once again --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 0d3bfc7d..0b9196eb 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -44,7 +44,7 @@ jobs: - name: Upload artifact uses: actions/upload-pages-artifact@v2 with: - path: ./ + path: ./docs/book # Deployment job deploy: