From 26f132ba9d83f88f67fda20841e6f0e3f4a5b8b0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Julian=20R=C3=BCth?= <julian.rueth@fsfe.org>
Date: Wed, 3 Apr 2024 23:54:11 +0300
Subject: [PATCH] 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. <!-- You do not need to build the documentation locally. A bot is recreating the documentation whenever there is a change to this PR and will maintain a link to the latest preview once it's ready. -->
 
 ### :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: