Skip to content

shellcheck fixes #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dannf merged 6 commits into from
Jul 31, 2025
Merged

shellcheck fixes #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f9a6b4c
shellcheck_run_steps: Pin upstream shellcheck container by SHA
dannf Jul 31, 2025
e6ef91d
shellcheck_run_steps: Use alternate shellcheck if specified
dannf Jul 31, 2025
f70da2f
shellcheck_run_steps: Use an argparse metavar as help text
dannf Jul 31, 2025
34d0741
example: shellcheck-run-steps
dannf Jul 31, 2025
4db9c5a
pre-commit-config: Don't spellcheck the example pre-commit file
dannf Jul 31, 2025
bd7e7ae
shellcheck_run_steps: please grype upstream shellcheck images
dannf Jul 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,4 @@ repos:
rev: 528d713e620bdf4b41849db93cb489c4fef9f5c5 # v0.6.0
hooks:
- id: misspell
exclude: '^example\.pre-commit-config\.yaml$'
9 changes: 7 additions & 2 deletions example.pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,13 @@ repos:
- repo: https://github.com/chainguard-dev/pre-commit-hooks
rev: 71fca50bcd1006b5cbcf71f03a3b493f48c4af7f
hooks:
# Not quite ready for prime time yet, due to a tool dependency outside the pre-commit managed environment.
#- id: shellcheck-run-steps
- id: shellcheck-run-steps
files: '^[^.][^/]*\.yaml$' # matches non-hidden .yaml files at the top level only
args:
- "--" # options to hook before this, options to shellcheck after
- "-S"
- "error"
- "--" # terminates shellcheck options, rest will be filenames
- id: check-for-epoch-bump
files: |
(?x)^(
Expand Down
11 changes: 7 additions & 4 deletions pre_commit_hooks/shellcheck_run_steps.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@

yaml = ruamel.yaml.YAML(typ="safe")

# Please provide the output of `grype koalaman/shellcheck@sha256:<newhash>`
# in your PR when bumping. Referenced by SHA for safety.
DefaultShellCheckImage = "koalaman/shellcheck@sha256:652a5a714dc2f5f97e36f565d4f7d2322fea376734f3ec1b04ed54ce2a0b124f"


def do_shellcheck(
melange_cfg: Mapping[str, Any],
Expand Down Expand Up @@ -55,7 +59,7 @@ def do_shellcheck(
shfile.write(step["runs"])
shfile.close()
subprocess.check_call(
["/usr/bin/shellcheck"]
shellcheck
+ shellcheck_args
+ ["--shell=busybox", "--"]
+ [os.path.basename(f.name) for _, f in all_steps],
Expand All @@ -68,8 +72,7 @@ def main(argv: Sequence[str] | None = None) -> int:
parser.add_argument(
"filenames",
nargs="*",
help="Filenames to check. You can also pass "
"arguments to shellcheck before a '--' separator.",
metavar="[-- SHELLCHECK ARGS -- ] FILENAMES",
)
parser.add_argument(
"--shellcheck",
Expand All @@ -79,7 +82,7 @@ def main(argv: Sequence[str] | None = None) -> int:
f"--volume={os.getcwd()}:/mnt",
"--rm",
"-it",
"koalaman/shellcheck:latest",
DefaultShellCheckImage,
],
nargs="*",
help="shellcheck command",
Expand Down
Loading