CI Docbuild: Silence documentation preview comment when there is no change #37739
Labels
Comments
saraedum
added a commit
to saraedum/sage
that referenced
this issue
Apr 3, 2024
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 sagemath#37387. See sagemath#37739 for futher ideas about a smarter behavior here.
5 tasks
vbraun
pushed a commit
to vbraun/sage
that referenced
this issue
Apr 11, 2024
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 sagemath#37387. See sagemath#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: sagemath#37740 Reported by: Julian Rüth Reviewer(s): Dima Pasechnik, Julian Rüth, Kwankyu Lee
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Wishlist item:
Suppress the preview comment when there is no change to the documentation.
Download a previously deployed documentation archive from netlify, and then suppress the preview comment if there was no change compared to that.
Originally posted by @kwankyu in #37387 (comment)
The text was updated successfully, but these errors were encountered: