From 26f132ba9d83f88f67fda20841e6f0e3f4a5b8b0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20R=C3=BCth?= Date: Wed, 3 Apr 2024 23:54:11 +0300 Subject: [PATCH 1/4] Disable most documentation notifications on GitHub Previously, the documentation comment on GitHub would be removed and then recreated which creates notification emails and to some feels like it's polluting their GitHub inbox. Here, we change this behavior so that only the initial build of the documentation causes such a notification. Further updates to the documentation, do update the links in the comment but do not trigger a notification. This is meant as an alternative to #37387. See #37739 for futher ideas about a smarter behavior here. --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- .github/workflows/doc-publish.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 35bc0b32282..d3bac1a015b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -15,7 +15,7 @@ - [ ] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. -- [ ] I have updated the documentation accordingly. +- [ ] I have updated the documentation and checked the generated documentation. ### :hourglass: Dependencies diff --git a/.github/workflows/doc-publish.yml b/.github/workflows/doc-publish.yml index 361dafb22e0..2e30ba0d32a 100644 --- a/.github/workflows/doc-publish.yml +++ b/.github/workflows/doc-publish.yml @@ -70,7 +70,7 @@ jobs: with: number: ${{ steps.source-run-info.outputs.pullRequestNumber }} header: preview-comment - recreate: true + recreate: false message: | [Documentation preview for this PR](${{ steps.deploy-netlify.outputs.NETLIFY_URL }}/html/en) (built with commit ${{ steps.source-run-info.outputs.sourceHeadSha }}; [changes](${{ steps.deploy-netlify.outputs.NETLIFY_URL }}/CHANGES.html)) is ready! :tada: From 0df6684949646c9845865b830077c41939ea77ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20R=C3=BCth?= Date: Thu, 4 Apr 2024 04:45:02 +0300 Subject: [PATCH 2/4] Move comment from PR template to generated post --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- .github/workflows/doc-publish.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d3bac1a015b..7c9f4e99849 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -15,7 +15,7 @@ - [ ] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. -- [ ] I have updated the documentation and checked the generated documentation. +- [ ] I have updated the documentation and checked the generated documentation. ### :hourglass: Dependencies diff --git a/.github/workflows/doc-publish.yml b/.github/workflows/doc-publish.yml index 2e30ba0d32a..6cb10900554 100644 --- a/.github/workflows/doc-publish.yml +++ b/.github/workflows/doc-publish.yml @@ -72,7 +72,7 @@ jobs: header: preview-comment recreate: false message: | - [Documentation preview for this PR](${{ steps.deploy-netlify.outputs.NETLIFY_URL }}/html/en) (built with commit ${{ steps.source-run-info.outputs.sourceHeadSha }}; [changes](${{ steps.deploy-netlify.outputs.NETLIFY_URL }}/CHANGES.html)) is ready! :tada: + [Documentation preview for this PR](${{ steps.deploy-netlify.outputs.NETLIFY_URL }}/html/en) (built with commit ${{ steps.source-run-info.outputs.sourceHeadSha }}; [changes](${{ steps.deploy-netlify.outputs.NETLIFY_URL }}/CHANGES.html)) is ready! :tada: This preview will update shortly after each push to this PR. - name: Update deployment status PR check uses: myrotvorets/set-commit-status-action@v2.0.0 From 715e89ab9652860d7087541fe1cb6d66ec759779 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20R=C3=BCth?= Date: Thu, 4 Apr 2024 04:47:56 +0300 Subject: [PATCH 3/4] Refer explicitly to the documentation preview in the PR template --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7c9f4e99849..4afd959f108 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -15,7 +15,7 @@ - [ ] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. -- [ ] I have updated the documentation and checked the generated documentation. +- [ ] I have updated the documentation and checked the documentation preview. ### :hourglass: Dependencies From 7dcf495af92438ebdda8e6f821905539e6793bb0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20R=C3=BCth?= Date: Thu, 4 Apr 2024 14:09:38 +0300 Subject: [PATCH 4/4] Break bot message into two lines --- .github/workflows/doc-publish.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/doc-publish.yml b/.github/workflows/doc-publish.yml index 6cb10900554..4c0f22338af 100644 --- a/.github/workflows/doc-publish.yml +++ b/.github/workflows/doc-publish.yml @@ -72,7 +72,8 @@ jobs: header: preview-comment recreate: false message: | - [Documentation preview for this PR](${{ steps.deploy-netlify.outputs.NETLIFY_URL }}/html/en) (built with commit ${{ steps.source-run-info.outputs.sourceHeadSha }}; [changes](${{ steps.deploy-netlify.outputs.NETLIFY_URL }}/CHANGES.html)) is ready! :tada: This preview will update shortly after each push to this PR. + [Documentation preview for this PR](${{ steps.deploy-netlify.outputs.NETLIFY_URL }}/html/en) (built with commit ${{ steps.source-run-info.outputs.sourceHeadSha }}; [changes](${{ steps.deploy-netlify.outputs.NETLIFY_URL }}/CHANGES.html)) is ready! :tada: + This preview will update shortly after each push to this PR. - name: Update deployment status PR check uses: myrotvorets/set-commit-status-action@v2.0.0 @@ -134,4 +135,3 @@ jobs: - name: Report deployment url run: | echo "::notice::The live documentation has been deployed - ${{ steps.deploy-netlify.outputs.NETLIFY_URL }}" -