ci: add linting, shellcheck for bash scripts #1427
Draft
Conversation
This file contains hidden or 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
Introduces https://github.com/getodk/central/blob/master/test/check-scripts.sh, with two changes: * disables tab/space indentation enforcement, as this repo currently uses both * ignores SC2038, as `find` does not generate exit codes in the same way as `xargs`, and current code will fail obviously if files are introduced with names which confuse xargs * does not ignore SC2016, as this repo does not have similar variable substitution to the odk-central repo Closes #1513
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Introduces https://github.com/getodk/central/blob/master/test/check-scripts.sh, with a few changes:
finddoes not generate exit codes in the same way asxargs, and current code will fail obviously if files are introduced with names which confuse xargsCloses getodk/central#1513
What has been done to verify that this works as intended?
New CI job.
Why is this the best possible solution? Were any other approaches considered?
Alternative would be to only introduce
shellcheck, and maybe to ignore all existing violations (as the code clearly works as-is).How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?
No change.
Does this change require updates to user documentation? If so, please file an issue here and include the link below.
No.
Before submitting this PR, please make sure you have:
npm run testandnpm run lintand confirmed all checks still pass OR confirm CircleCI build passes