Introduced draft of SSG Bash scripting guidelines.#2633
Merged
mpreisler merged 1 commit intoComplianceAsCode:masterfrom Feb 28, 2018
Merged
Introduced draft of SSG Bash scripting guidelines.#2633mpreisler merged 1 commit intoComplianceAsCode:masterfrom
mpreisler merged 1 commit intoComplianceAsCode:masterfrom
Conversation
33b799d to
e7c18fd
Compare
e7c18fd to
a86c92d
Compare
Member
|
ACK, great stuff! |
Member
|
Agreed, thank you for doing this @matejak! |
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
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.
As @OnceUponALoop in #2617 noticed, it is not clear what style and approach to prefer when contributing to Bash remediations.
I have went to the existing remediations in the
shared/fixes/bashfolder and observed the prevalent existing style. I have found out two points which I believe that are not controversial at all:sedgreatly surpassesawk, so let's encouragesed.Next, I propose these:
diefunction idiom to handle possible errors (I have defined it and checked that it can be actually used).shellcheckover the snippet and try to fix all warnings.if ! [ $x != 1 ]; then ...Finally, some points may be controversial:
bash -eor by writingset -eto the top of the script. This imposes greater requirements on error handling inside the script and therefore increases its robustness.