CI: new job which fails if a file contains FIXME #5121
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When working on a big PR, sometimes you have something you know you need to fix before merging. With this CI job, just add a FIXME comment and you'll be forced to address it before all CI can pass. We intentionally allow CI to make tarballs for a commit and publish npm packages even with FIXME, because you may want to test out a build of an incomplete PR. Change existing TODO comments to FIXME. Document this requirement in CONTRIBUTING.md and make the text about PRs with failing tests a bit gentler.
glasser
force-pushed
the
glasser/fixme-ci
branch
from
ed46013 to
77eda06
Compare
trevor-scheer
approved these changes
Apr 19, 2021
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When working on a big PR, sometimes you have something you know you need to fix
before merging. With this CI job, just add a FIXME comment and you'll be forced
to address it before all CI can pass.
We intentionally allow CI to make tarballs for a commit and publish npm packages
even with FIXME, because you may want to test out a build of an incomplete PR.
Change existing TODO comments to FIXME. Document this requirement in
CONTRIBUTING.md and make the text about PRs with failing tests a bit gentler.