Skip to content

Commit

Permalink
gh-37740: Disable most documentation notifications on GitHub
Browse files Browse the repository at this point in the history
    
Previously, the documentation comment on GitHub would be removed and
then recreated whenever there is a change to a PR 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.

An actual preview of the result can be seen here:
saraedum#2

Note that the links on that PR do not work because my fork does not have
netlify credentials configured.

### 📝 Checklist

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [x] I have created tests covering the changes; this is fairly hard to
test automatically. I'll test this manually if there is interest in
merging this.
- [x] I have updated the documentation accordingly; kind of, I updated
the PR checklist.
    
URL: #37740
Reported by: Julian Rüth
Reviewer(s): Dima Pasechnik, Julian Rüth, Kwankyu Lee
  • Loading branch information
Release Manager committed Apr 10, 2024
2 parents c5e0a87 + 7dcf495 commit 98ae3ed
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 documentation preview.

### :hourglass: Dependencies

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/doc-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,10 @@ 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:
This preview will update shortly after each push to this PR.
- name: Update deployment status PR check
uses: myrotvorets/[email protected]
Expand Down Expand Up @@ -134,4 +135,3 @@ jobs:
- name: Report deployment url
run: |
echo "::notice::The live documentation has been deployed - ${{ steps.deploy-netlify.outputs.NETLIFY_URL }}"

0 comments on commit 98ae3ed

Please sign in to comment.