Add --compare-file-text=soft #252
Closed
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.
Overview
This pull request expands upon the "force" option added in #251. This forces the "compare file text" feature to be used, but does not raise an exception if it fails. Hence "soft".
This is useful when octocatalog-diff runs are being broken into individual components (e.g. leveraging bazel for caching). One process compiles the "to" catalog and another compiles the "from" catalog, and then a third step takes those two catalogs as input and does the "diff". To make the "compare file text" function work in this case, we have to force it on for the compilation of the "to" catalog (hence #251) and force it on, but not raise an exception for problems, for the compilation of the "from" catalog (this PR).
I updated the docs accordingly and added additional integration tests for these options, in addition to the unit tests at 💯 as per project requirements. In addition we have been using this for several months at my employer and it's been working as intended.
Checklist
rake
in your checkout directory, or review the CI job triggered whenever you push to a pull request.rake coverage:spec
or ignoring untestable sections of code with# :nocov
comments. If you need help getting to 100% coverage please ask; however, don't just submit code with no tests.