Commit d40621c
fix shellcheck and auto fix (#372)
# Summary
This pull request focuses on improving shell script robustness and
consistency across the codebase. The most significant change is an
enhancement to the pre-commit hook's `shellcheck` integration, which now
attempts to auto-fix issues and provides a clearer summary of failures.
**Shellcheck automation and reporting:**
* Enhanced the `.githooks/pre-commit` script to attempt auto-fixing
shellcheck issues, collect failed files, and display a summary of
failures instead of exiting on the first error. This improves developer
experience and code quality.
* We will not print each file we check, that is not useful information.
Only print if we fixed one or were unable to fix it automatically
## Proof of Work
- running `make precommit` locally - failing:
```
update_jobs: user 0m0.053s
update_jobs: sys 0m0.042s
lint_code: Go Version: go version go1.24.0 darwin/arm64
lint_code: Running golangci-lint...
start_shellcheck: shellcheck failed on scripts/dev/recreate_python_venv.sh
start_shellcheck:
start_shellcheck: In scripts/dev/recreate_python_venv.sh line 80:
start_shellcheck: sudo apt-get update -qq && sudo apt-get install -y python3-venv || true
start_shellcheck: ^-- SC2015 (info): Note that A && B || C is not if-then-else. C may run when A is true.
start_shellcheck:
start_shellcheck: For more information:
start_shellcheck: https://www.shellcheck.net/wiki/SC2015 -- Note that A && B || C is not if-t...
Some checks have failed:
start_shellcheck (PID 53467)
To see the details look for the job's logs by it's prefixed name (e.g. "shellcheck failed"
```
- passing:
```
ython_formatting: Skipped 8 files
python_formatting: formatting black
python_formatting: All done! ✨ 🍰 ✨
python_formatting: 410 files left unchanged.
real 0m11.694s
user 0m2.030s
sys 0m5.022s
pre-commit: All checks passed!
...
```
## Checklist
- [ ] Have you linked a jira ticket and/or is the ticket in the title?
- [ ] Have you checked whether your jira ticket required DOCSP changes?
- [ ] Have you added changelog file?
- use `skip-changelog` label if not needed
- refer to [Changelog files and Release
Notes](https://github.com/mongodb/mongodb-kubernetes/blob/master/CONTRIBUTING.md#changelog-files-and-release-notes)
section in CONTRIBUTING.md for more details
---------
Co-authored-by: Łukasz Sierant <[email protected]>
Co-authored-by: Lucian Tosa <[email protected]>1 parent 33bd4d9 commit d40621c
File tree
9 files changed
+25
-17
lines changed- .githooks
- scripts
- dev
- evergreen
- e2e
- minikube
9 files changed
+25
-17
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
202 | 202 | | |
203 | 203 | | |
204 | 204 | | |
205 | | - | |
| 205 | + | |
206 | 206 | | |
207 | 207 | | |
208 | 208 | | |
| |||
229 | 229 | | |
230 | 230 | | |
231 | 231 | | |
232 | | - | |
233 | | - | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
234 | 240 | | |
235 | | - | |
| 241 | + | |
| 242 | + | |
236 | 243 | | |
237 | 244 | | |
238 | 245 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
77 | 77 | | |
78 | 78 | | |
79 | 79 | | |
80 | | - | |
| 80 | + | |
| 81 | + | |
81 | 82 | | |
82 | 83 | | |
83 | 84 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
105 | 105 | | |
106 | 106 | | |
107 | 107 | | |
108 | | - | |
| 108 | + | |
109 | 109 | | |
110 | 110 | | |
111 | 111 | | |
112 | | - | |
| 112 | + | |
113 | 113 | | |
114 | 114 | | |
115 | 115 | | |
116 | 116 | | |
117 | 117 | | |
118 | | - | |
| 118 | + | |
119 | 119 | | |
120 | 120 | | |
121 | 121 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
33 | 33 | | |
34 | 34 | | |
35 | 35 | | |
36 | | - | |
| 36 | + | |
37 | 37 | | |
38 | 38 | | |
39 | 39 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | | - | |
| 12 | + | |
13 | 13 | | |
14 | 14 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
58 | 58 | | |
59 | 59 | | |
60 | 60 | | |
61 | | - | |
62 | | - | |
| 61 | + | |
| 62 | + | |
63 | 63 | | |
64 | 64 | | |
65 | 65 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
15 | | - | |
| 15 | + | |
16 | 16 | | |
17 | 17 | | |
18 | 18 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
25 | | - | |
| 25 | + | |
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
32 | | - | |
| 32 | + | |
33 | 33 | | |
34 | 34 | | |
35 | 35 | | |
| |||
50 | 50 | | |
51 | 51 | | |
52 | 52 | | |
53 | | - | |
| 53 | + | |
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
| |||
63 | 63 | | |
64 | 64 | | |
65 | 65 | | |
66 | | - | |
| 66 | + | |
67 | 67 | | |
68 | 68 | | |
69 | 69 | | |
| |||
0 commit comments