Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.Sign up
Don't run CI for *.md file changes. #7537
#7526 adds the SKIP_FULL_CI label to the commit message of commits that only touch *.md files.
This change causes CI to skip all commits with that label. This is to encourage people to fix and update documentation without incurring the overhead and nuisance of CI.
Note that we don't even build the docsite on SKIP_FULL_CI changes, because that would still require bootstrapping pants. Such changes will still require review, and it's easy to view the rendered .md files to check for rendering errors, either locally or on github.com, so for now we err on the side of streamlining. If we notice a trend of bad doc formatting because of this, we can reconsider.
Note also that adding new doc pages will require changes to BUILD files, and so will trigger a full CI, including docsite generation.
Eric-Arellano left a comment
To clarify, the marking of the commit message is completely automated, right? But it requires the user to first install the Git Hooks? If this is the case, first beneficiary of this PR could be updating the docs on how to update docs to mention the need for installing git hooks: https://www.pantsbuild.org/docs.html.