Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Validate documentation changes in pull requests #17798
In gh-16822, we re-implemented the website build process to use Sphinx via a GitHub Action. Soon after, we modified the script for use in validating pull requests. By performing all of the work except for final publication, we expected the script to verify that new patches would not introduce problems in the build process.
Contrary to our expectation, GitHub did not execute the script to validate new commits pushed to pull requests. We recognized this problem only after merging a faulty documentation patch.
We should work out how to change our configuration such that pull requests to the documentation are validated along these lines. My initial thought was to create a GitHub Workflow which listens to the
@Hexcles any thoughts on this?
That whole paragraph reads quite confusing to me. GitHub sends
Then I discovered this article:
which suggests we should also listen to
The workaround in the article is suboptimal, too, so perhaps the best workaround is to create feature branches here instead of on a fork.