[workflow] Use Sphinx problem matcher on docs builds #20325
Conversation
7172d99 to
52d771d
Compare
52d771d to
819f2e7
Compare
|
@ammaraskar Could you simulate some sphinx problem to see how it looks? (You can then add another commit to revert it). |
dea7559 to
c550385
Compare
|
I added two quick errors for testing, looks like |
|
Hmmm, giving that we are treating warnings as errors already, does it make sense to add the sphynx one? I find a bit misleading also that it only reports the first one (I understand why it happens), but if a contributor uses this new system to locate errors it would be very frustrating. Maybe I am missing some detail, though. What do you think? |
c550385 to
5c44836
Compare
Yeah, I was thinking this one is not as necessary as the compiler warning ones. Take a look now, I discovered there was The main advantage of this would be that contributors who aren't that used to Sphinx/rst don't have to go looking through the logs to find out why the build is failing. It provides the errors in a more seamless way for a Github web editor workflow. |
Yeah, that is true. I think there is some value in this. Could you remove the failure changes so we can land this? |
5c44836 to
bce56fd
Compare
|
Done :) |
|
🚀 Thanks for the good work @ammaraskar ! |
This makes warnings and errors from the compiler very prominent so this should help prevent warnings from sneaking into the code base and catch them in review. See https://discuss.python.org/t/using-github-problem-matchers-to-catch-warnings-early/4254 for more details You can see a demo of this in action here: https://github.com/ammaraskar/cpython/pull/15/files#diff-9ba2eeca0f254ece0a9df4d7cb68e870 GCC and Sphinx matchers have previously been added in GH-18567 and GH-20325, respectively.
…H-18532) This makes warnings and errors from the compiler very prominent so this should help prevent warnings from sneaking into the code base and catch them in review. See https://discuss.python.org/t/using-github-problem-matchers-to-catch-warnings-early/4254 for more details You can see a demo of this in action here: https://github.com/ammaraskar/cpython/pull/15/files#diff-9ba2eeca0f254ece0a9df4d7cb68e870 GCC and Sphinx matchers have previously been added in pythonGH-18567 and pythonGH-20325, respectively.
See https://discuss.python.org/t/using-github-problem-matchers-to-catch-warnings-early/4254 for more details.
This adds a problem matcher to show errors from the Sphinx build prominently in pull requests.