From bdae6026a11a217ae98ae2caed5d7f43ddde19e4 Mon Sep 17 00:00:00 2001 From: Daniel Arndt Date: Mon, 3 Feb 2025 12:05:04 -0500 Subject: [PATCH 1/3] Allow writing contents when deploying --- .github/workflows/deploy_docs.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml index bd373cd11..b5fbcb080 100644 --- a/.github/workflows/deploy_docs.yml +++ b/.github/workflows/deploy_docs.yml @@ -11,6 +11,8 @@ jobs: env: docs-directory: /home/runner/work/kokkos-core-wiki/kokkos-core-wiki/docs python-version: '3.10' + permissions: + contents: write steps: - uses: actions/checkout@v3 From b123a9e0e70a74b31341e810f6cad168f557e918 Mon Sep 17 00:00:00 2001 From: Daniel Arndt Date: Mon, 3 Feb 2025 13:59:58 -0500 Subject: [PATCH 2/3] Restrict write permissions to deploy step --- .github/workflows/deploy_docs.yml | 35 ++++++++++++++++++++----------- 1 file changed, 23 insertions(+), 12 deletions(-) diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml index b5fbcb080..2f09802f0 100644 --- a/.github/workflows/deploy_docs.yml +++ b/.github/workflows/deploy_docs.yml @@ -6,13 +6,11 @@ on: pull_request: jobs: - build-and-deploy-docs: + build: runs-on: ubuntu-latest env: docs-directory: /home/runner/work/kokkos-core-wiki/kokkos-core-wiki/docs python-version: '3.10' - permissions: - contents: write steps: - uses: actions/checkout@v3 @@ -28,21 +26,34 @@ jobs: working-directory: ${{ env.docs-directory }} run: | make html - - name: Archive documentation - uses: actions/upload-artifact@v4 - with: - name: documentation.tar.gz - path: ${{ env.docs-directory }}/generated_docs - # .nojekyll file is needed for GitHub Pages to know it's getting a ready webpage # and there is no need to generate anything - name: Generate nojekyll file working-directory: ${{ env.docs-directory }}/generated_docs run: touch .nojekyll - # This action moves the content of `generated_docs` to the `deploy-doc-site` branch + - name: Upload Artifacts + uses: actions/upload-artifact@v4 + with: + name: site + path: ${{ env.docs-directory }}/generated_docs + + deploy-docs: + if: ${{ github.ref == 'refs/heads/main' }} + needs: build + runs-on: ubuntu-latest + permissions: + contents: write + + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Download Artifacts + uses: actions/download-artifact@v4 + with: + name: site + path: generated_docs - name: Deploy docs - if: ${{ github.ref == 'refs/heads/main' }} uses: JamesIves/github-pages-deploy-action@v4 with: branch: deploy-doc-site - folder: ${{ env.docs-directory }}/generated_docs + folder: generated_docs clean: true From 9d8baeccfad0450e0d9d27abf06085a2ac3ccb58 Mon Sep 17 00:00:00 2001 From: Daniel Arndt Date: Tue, 4 Feb 2025 15:51:14 -0500 Subject: [PATCH 3/3] Fix removing half of a comment --- .github/workflows/deploy_docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml index 2f09802f0..56311e532 100644 --- a/.github/workflows/deploy_docs.yml +++ b/.github/workflows/deploy_docs.yml @@ -26,6 +26,7 @@ jobs: working-directory: ${{ env.docs-directory }} run: | make html + # .nojekyll file is needed for GitHub Pages to know it's getting a ready webpage # and there is no need to generate anything - name: Generate nojekyll file working-directory: ${{ env.docs-directory }}/generated_docs