From 5ad76a06799b96c386119106eb6ca85b54cfd56f Mon Sep 17 00:00:00 2001 From: Michael Telatynski <7t3chguy@gmail.com> Date: Thu, 2 Jun 2022 08:34:03 +0100 Subject: [PATCH 1/4] Upload documentation PRs to Netlify Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> --- .github/workflows/docs-pr-netlify.yaml | 34 ++++++++++++++++++++++++++ .github/workflows/docs-pr.yaml | 34 ++++++++++++++++++++++++++ 2 files changed, 68 insertions(+) create mode 100644 .github/workflows/docs-pr-netlify.yaml create mode 100644 .github/workflows/docs-pr.yaml diff --git a/.github/workflows/docs-pr-netlify.yaml b/.github/workflows/docs-pr-netlify.yaml new file mode 100644 index 000000000000..7cc3b4d9be5a --- /dev/null +++ b/.github/workflows/docs-pr-netlify.yaml @@ -0,0 +1,34 @@ +name: Deploy documentation PR preview + +on: + workflow_run: + workflows: [ "Prepare documentation PR preview" ] + types: + - completed + +jobs: + netlify: + if: github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.event == 'pull_request' + runs-on: ubuntu-latest + steps: + # There's a 'download artifact' action, but it hasn't been updated for the workflow_run action + # (https://github.com/actions/download-artifact/issues/60) so instead we get this mess: + - name: 📥 Download artifact + uses: dawidd6/action-download-artifact@af92a8455a59214b7b932932f2662fdefbd78126 # v2.15.0 + with: + workflow: docs-pr.yaml + run_id: ${{ github.event.workflow_run.id }} + name: book + path: book + + - name: 📤 Deploy to Netlify + uses: matrix-org/netlify-pr-preview@v1 + with: + path: book + owner: ${{ github.event.workflow_run.head_repository.owner.login }} + branch: ${{ github.event.workflow_run.head_branch }} + revision: ${{ github.event.workflow_run.head_sha }} + token: ${{ secrets.NETLIFY_AUTH_TOKEN }} + site_id: ${{ secrets.NETLIFY_SITE_ID }} + desc: Documentation preview + deployment_env: PR Documentation Preview diff --git a/.github/workflows/docs-pr.yaml b/.github/workflows/docs-pr.yaml new file mode 100644 index 000000000000..1910e72fe2bc --- /dev/null +++ b/.github/workflows/docs-pr.yaml @@ -0,0 +1,34 @@ +name: Prepare documentation PR preview + +on: + pull_request: + paths: + - docs + +jobs: + pages: + name: GitHub Pages + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + + - name: Setup mdbook + uses: peaceiris/actions-mdbook@4b5ef36b314c2599664ca107bb8c02412548d79d # v1.1.14 + with: + mdbook-version: '0.4.17' + + - name: Build the documentation + # mdbook will only create an index.html if we're including docs/README.md in SUMMARY.md. + # However, we're using docs/README.md for other purposes and need to pick a new page + # as the default. Let's opt for the welcome page instead. + run: | + mdbook build + cp book/welcome_and_overview.html book/index.html + + - name: Upload Artifact + uses: actions/upload-artifact@v2 + with: + name: book + path: book + # We'll only use this in a workflow_run, then we're done with it + retention-days: 1 From ae4f5105302090c9d6066ed60d81a4193ef55797 Mon Sep 17 00:00:00 2001 From: David Robertson Date: Thu, 20 Oct 2022 11:41:07 +0100 Subject: [PATCH 2/4] Changelog --- changelog.d/12947.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/12947.doc diff --git a/changelog.d/12947.doc b/changelog.d/12947.doc new file mode 100644 index 000000000000..5319e9ad4fe8 --- /dev/null +++ b/changelog.d/12947.doc @@ -0,0 +1 @@ +Upload documentation PRs to Netlify. From 2edccbb8f68711f5a3a710d88f1fab13106699e5 Mon Sep 17 00:00:00 2001 From: Brendan Abolivier Date: Fri, 4 Nov 2022 16:18:57 +0000 Subject: [PATCH 3/4] tmp: add change to deploy --- docs/modules/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/modules/index.md b/docs/modules/index.md index 0a868b309f2f..f0f283a1a3e3 100644 --- a/docs/modules/index.md +++ b/docs/modules/index.md @@ -1,3 +1,5 @@ +Heyo this is a test! + # Modules Synapse supports extending its functionality by configuring external modules. From 3c04d9c05b453a23eed27f16905e0f82907dd3e8 Mon Sep 17 00:00:00 2001 From: Brendan Abolivier Date: Fri, 4 Nov 2022 16:30:02 +0000 Subject: [PATCH 4/4] Revert "tmp: add change to deploy" This reverts commit 2edccbb8f68711f5a3a710d88f1fab13106699e5. --- docs/modules/index.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/modules/index.md b/docs/modules/index.md index f0f283a1a3e3..0a868b309f2f 100644 --- a/docs/modules/index.md +++ b/docs/modules/index.md @@ -1,5 +1,3 @@ -Heyo this is a test! - # Modules Synapse supports extending its functionality by configuring external modules.