From 6d9f767559444df49bde75538950745edda7b2a7 Mon Sep 17 00:00:00 2001 From: Dusan Vuckovic Date: Thu, 9 Jan 2025 14:50:34 +0000 Subject: [PATCH 1/8] Maintenance: Post artifact links to associated PR. --- .github/workflows/docs.yml | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index d16d8d5..0cb62ec 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -102,19 +102,38 @@ jobs: run: echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT - name: Upload html Artifact - uses: actions/upload-artifact@v3 + id: html + uses: actions/upload-artifact@v4 with: name: html-${{ steps.sha.outputs.sha_short }} path: ${{ inputs.docs_path }}/_build/html/ - name: Upload htmlzip Artifact - uses: actions/upload-artifact@v3 + id: htmlzip + uses: actions/upload-artifact@v4 with: name: htmlzip-${{ steps.sha.outputs.sha_short }} path: ${{ inputs.docs_path }}/_build/htmlzip/ - name: Upload epub Artifact - uses: actions/upload-artifact@v3 + id: epub + uses: actions/upload-artifact@v4 with: name: epub-${{ steps.sha.outputs.sha_short }} path: ${{ inputs.docs_path }}/_build/epub/*.epub + + - name: Post Artifact Links to PR + if: github.event_name == 'pull_request' + uses: actions/github-script@v5 + with: + script: | + github.rest.issues.createComment({ + issue_number: context.issue.number, + owner: context.repo.owner, + repo: context.repo.repo, + body: ' + [html-${{ steps.sha.outputs.sha_short }}](${{ steps.html.outputs.artifact-url }})\n + [htmlzip-${{ steps.sha.outputs.sha_short }}](${{ steps.htmlzip.outputs.artifact-url }})\n + [epub-${{ steps.sha.outputs.sha_short }}](${{ steps.epub.outputs.artifact-url }}) + ' + }) From 76c19a04400b027eae6304557ace1ea7da273e0a Mon Sep 17 00:00:00 2001 From: Dusan Vuckovic Date: Thu, 9 Jan 2025 14:58:52 +0000 Subject: [PATCH 2/8] fix: Include default token. --- .github/workflows/docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 0cb62ec..aed6ba7 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -126,6 +126,7 @@ jobs: if: github.event_name == 'pull_request' uses: actions/github-script@v5 with: + github-token: ${{secrets.GITHUB_TOKEN}} script: | github.rest.issues.createComment({ issue_number: context.issue.number, From e1cd6327f7ff02944711207a7f16a00987be3ebc Mon Sep 17 00:00:00 2001 From: Dusan Vuckovic Date: Thu, 9 Jan 2025 15:05:42 +0000 Subject: [PATCH 3/8] fix: Specify permissions. --- .github/workflows/docs.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index aed6ba7..68d54d3 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -27,6 +27,10 @@ on: default: requirements.txt type: string +permissions: + contents: read + pull-requests: write + jobs: build: name: Build @@ -126,7 +130,6 @@ jobs: if: github.event_name == 'pull_request' uses: actions/github-script@v5 with: - github-token: ${{secrets.GITHUB_TOKEN}} script: | github.rest.issues.createComment({ issue_number: context.issue.number, From 95867255eba7107958613edea065c6765060089e Mon Sep 17 00:00:00 2001 From: Dusan Vuckovic Date: Thu, 9 Jan 2025 15:08:09 +0000 Subject: [PATCH 4/8] fix: Specify permissions. --- .github/workflows/docs.yml | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 68d54d3..6af3506 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -27,14 +27,13 @@ on: default: requirements.txt type: string -permissions: - contents: read - pull-requests: write - jobs: build: name: Build runs-on: ubuntu-latest + permissions: + contents: read + pull-requests: write steps: - name: Checkout Repository uses: actions/checkout@v3 From 180f2fc798f3d66ae60a27360e8db47877f65312 Mon Sep 17 00:00:00 2001 From: Dusan Vuckovic Date: Thu, 9 Jan 2025 15:10:07 +0000 Subject: [PATCH 5/8] fix: Specify permissions. --- .github/workflows/docs.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 6af3506..365aa9d 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -34,6 +34,8 @@ jobs: permissions: contents: read pull-requests: write + repository-projects: write + id-token: write steps: - name: Checkout Repository uses: actions/checkout@v3 From 3614672d58d654d9e3d042c9045c7bfd69e8416d Mon Sep 17 00:00:00 2001 From: Dusan Vuckovic Date: Thu, 9 Jan 2025 15:14:33 +0000 Subject: [PATCH 6/8] yolo: wrapping should work properly. Probably. --- .github/workflows/docs.yml | 27 +++++++++------------------ 1 file changed, 9 insertions(+), 18 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 365aa9d..c0f29dc 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -31,11 +31,6 @@ jobs: build: name: Build runs-on: ubuntu-latest - permissions: - contents: read - pull-requests: write - repository-projects: write - id-token: write steps: - name: Checkout Repository uses: actions/checkout@v3 @@ -127,18 +122,14 @@ jobs: name: epub-${{ steps.sha.outputs.sha_short }} path: ${{ inputs.docs_path }}/_build/epub/*.epub - - name: Post Artifact Links to PR + - name: Comment PR with Artifact Links if: github.event_name == 'pull_request' - uses: actions/github-script@v5 + uses: thollander/actions-comment-pull-request@v3 with: - script: | - github.rest.issues.createComment({ - issue_number: context.issue.number, - owner: context.repo.owner, - repo: context.repo.repo, - body: ' - [html-${{ steps.sha.outputs.sha_short }}](${{ steps.html.outputs.artifact-url }})\n - [htmlzip-${{ steps.sha.outputs.sha_short }}](${{ steps.htmlzip.outputs.artifact-url }})\n - [epub-${{ steps.sha.outputs.sha_short }}](${{ steps.epub.outputs.artifact-url }}) - ' - }) + message: | + ### Artifacts + Produced during runtime: + * [html-${{ steps.sha.outputs.sha_short }}](${{ steps.html.outputs.artifact-url }}) + * [htmlzip-${{ steps.sha.outputs.sha_short }}](${{ steps.htmlzip.outputs.artifact-url }}) + * [epub-${{ steps.sha.outputs.sha_short }}](${{ steps.epub.outputs.artifact-url }}) + comment-tag: artifacts From 7ef7918f8f6e1b72f02e7ab8429cc1fb7b59aaad Mon Sep 17 00:00:00 2001 From: Dusan Vuckovic Date: Thu, 9 Jan 2025 15:19:49 +0000 Subject: [PATCH 7/8] chore: Trigger CI. --- .github/workflows/docs.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index c0f29dc..a71c7e6 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -122,14 +122,14 @@ jobs: name: epub-${{ steps.sha.outputs.sha_short }} path: ${{ inputs.docs_path }}/_build/epub/*.epub - - name: Comment PR with Artifact Links + - name: Post Comment to PR with Artifact Links if: github.event_name == 'pull_request' uses: thollander/actions-comment-pull-request@v3 with: + comment-tag: artifacts message: | ### Artifacts - Produced during runtime: - * [html-${{ steps.sha.outputs.sha_short }}](${{ steps.html.outputs.artifact-url }}) - * [htmlzip-${{ steps.sha.outputs.sha_short }}](${{ steps.htmlzip.outputs.artifact-url }}) - * [epub-${{ steps.sha.outputs.sha_short }}](${{ steps.epub.outputs.artifact-url }}) - comment-tag: artifacts + Produced during runtime + 📦 [epub-${{ steps.sha.outputs.sha_short }}](${{ steps.epub.outputs.artifact-url }}) + 📦 [html-${{ steps.sha.outputs.sha_short }}](${{ steps.html.outputs.artifact-url }}) + 📦 [htmlzip-${{ steps.sha.outputs.sha_short }}](${{ steps.htmlzip.outputs.artifact-url }}) From 38460793d22d1f94a27b8c3ca32b18328ed81e31 Mon Sep 17 00:00:00 2001 From: Dusan Vuckovic Date: Thu, 9 Jan 2025 15:21:33 +0000 Subject: [PATCH 8/8] chore: Trigger CI. --- .github/workflows/docs.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index a71c7e6..7fe522d 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -129,7 +129,9 @@ jobs: comment-tag: artifacts message: | ### Artifacts + Produced during runtime + 📦 [epub-${{ steps.sha.outputs.sha_short }}](${{ steps.epub.outputs.artifact-url }}) 📦 [html-${{ steps.sha.outputs.sha_short }}](${{ steps.html.outputs.artifact-url }}) 📦 [htmlzip-${{ steps.sha.outputs.sha_short }}](${{ steps.htmlzip.outputs.artifact-url }})