Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't run CI for *.md file changes. #7537

Merged
merged 1 commit into from Apr 12, 2019

Conversation

Projects
None yet
4 participants
@benjyw
Copy link
Contributor

commented Apr 12, 2019

#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
Copy link
Contributor

left a comment

Fantastic!

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.

@benjyw benjyw force-pushed the benjyw:skip_ci_for_doc_changes branch from 559b1c9 to 4acd493 Apr 12, 2019

@codealchemy
Copy link
Contributor

left a comment

👍

@benjyw benjyw force-pushed the benjyw:skip_ci_for_doc_changes branch 2 times, most recently from 135bb37 to 6230312 Apr 12, 2019

@benjyw benjyw force-pushed the benjyw:skip_ci_for_doc_changes branch from 6230312 to 485a327 Apr 12, 2019

@benjyw benjyw merged commit 946c4bf into pantsbuild:master Apr 12, 2019

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@benjyw benjyw deleted the benjyw:skip_ci_for_doc_changes branch Apr 12, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.