Check for dirty-files post-build #116
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
If the `.cabal` or `.yaml.lock` files are checked into git, and the build produces changes to them, that is an error. It means the user made a change to `package.yaml` or `stack.yaml` and forgot to commit the resulting change in the related file. We'd like `stack-action` to catch this error when run on the PRs that introduce it, since it's easy to miss and can result in bigger problems later (e.g. when that lands on `main` and/or is released). To start, we'll `warn`, but we may shift the default to `error` in the future.
Users may be choosing to not commit generated files, in which case they'd be expected here and we should not warn (or error) about them.
stackptr
approved these changes
Aug 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
If the
.cabalor.yaml.lockfiles are checked into git, and thebuild produces changes to them, that is an error. It means the user made
a change to
package.yamlorstack.yamland forgot to commit theresulting change in the related file.
We'd like
stack-actionto catch this error when run on the PRs thatintroduce it, since it's easy to miss and can result in bigger problems
later (e.g. when that lands on
mainand/or is released). To start,we'll
warn, but we may shift the default toerrorin the future.Closes #2