pants: Add shellcheck for shell_source(s) targets

cognifloyd · cognifloyd · commit 46fabcdfdd4a · 2022-10-08T14:12:38.000-05:00
This excludes some scripts from shellcheck because they weren't linted
previously. We can clean them up in one or more follow-up PRs and remove
`skip_shellcheck=True` from the relevant BUILD targets to re-enable
shellcheck for those files.
diff --git a/contrib/core/actions/send_mail/BUILD b/contrib/core/actions/send_mail/BUILD
@@ -1,3 +1,4 @@
 shell_source(
     source="send_mail",
+    skip_shellcheck=True,
 )
diff --git a/contrib/examples/actions/BUILD b/contrib/examples/actions/BUILD
@@ -2,4 +2,5 @@ python_sources()
 
 shell_sources(
     name="shell",
+    skip_shellcheck=True,
 )
diff --git a/contrib/examples/actions/bash_ping/BUILD b/contrib/examples/actions/bash_ping/BUILD
@@ -1 +1 @@
-shell_sources()
+shell_sources(skip_shellcheck=True)
diff --git a/contrib/examples/actions/bash_random/BUILD b/contrib/examples/actions/bash_random/BUILD
@@ -1 +1,5 @@
-shell_sources()
+shell_sources(
+    overrides={
+        "random2.sh": {"skip_shellcheck": True},
+    },
+)
diff --git a/contrib/linux/actions/BUILD b/contrib/linux/actions/BUILD
@@ -2,4 +2,5 @@ python_sources()
 
 shell_sources(
     name="shell",
+    skip_shellcheck=True,
 )
diff --git a/pants.toml b/pants.toml
@@ -15,6 +15,7 @@ backend_packages = [
 
   # shell
   "pants.backend.shell",
+  "pants.backend.shell.lint.shellcheck",
 ]
 # pants ignores files in .gitignore, .*/ directories, /dist/ directory, and __pycache__.
 pants_ignore.add = [
diff --git a/st2actions/bin/BUILD b/st2actions/bin/BUILD
@@ -4,4 +4,5 @@ python_sources(
 
 shell_sources(
     name="shell",
+    skip_shellcheck=True,
 )
diff --git a/st2common/bin/BUILD b/st2common/bin/BUILD
@@ -5,4 +5,5 @@ python_sources(
 shell_sources(
     name="shell",
     sources=["st2ctl", "st2-self-check", "st2-run-pack-tests"],
+    skip_shellcheck=True,
 )
diff --git a/st2common/bin/migrations/v2.1/BUILD b/st2common/bin/migrations/v2.1/BUILD
@@ -2,4 +2,5 @@ python_sources()
 
 shell_sources(
     name="shell",
+    skip_shellcheck=True,
 )
diff --git a/st2tests/integration/BUILD b/st2tests/integration/BUILD
@@ -1,3 +1,4 @@
 shell_sources(
     name="shell",
+    skip_shellcheck=True,
 )
diff --git a/st2tests/st2tests/fixtures/packs/BUILD b/st2tests/st2tests/fixtures/packs/BUILD
@@ -14,6 +14,7 @@ resources(
 
 shell_sources(
     name="test_content_version_shell",
+    skip_shellcheck=True,
     sources=[
         "test_content_version/**/*.sh",
     ],
diff --git a/st2tests/testpacks/errorcheck/actions/BUILD b/st2tests/testpacks/errorcheck/actions/BUILD
@@ -1 +1 @@
-shell_sources()
+shell_sources(skip_shellcheck=True)
diff --git a/tools/BUILD b/tools/BUILD
@@ -6,4 +6,5 @@ shell_sources(
         "*.sh",
         "st2-setup-*",
     ],
+    skip_shellcheck=True,
 )

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
`1`	`1`	`shell_source(`
`2`	`2`	`source="send_mail",`
	`3`	`+ skip_shellcheck=True,`
`3`	`4`	`)`
Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,5 @@ python_sources()`
`2`	`2`
`3`	`3`	`shell_sources(`
`4`	`4`	`name="shell",`
	`5`	`+ skip_shellcheck=True,`
`5`	`6`	`)`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-shell_sources()`
	`1`	`+shell_sources(skip_shellcheck=True)`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ backend_packages = [`
`15`	`15`
`16`	`16`	`# shell`
`17`	`17`	`"pants.backend.shell",`
	`18`	`+ "pants.backend.shell.lint.shellcheck",`
`18`	`19`	`]`
`19`	`20`	`# pants ignores files in .gitignore, .*/ directories, /dist/ directory, and __pycache__.`
`20`	`21`	`pants_ignore.add = [`
Original file line number	Diff line number	Diff line change
`@@ -4,4 +4,5 @@ python_sources(`
`4`	`4`
`5`	`5`	`shell_sources(`
`6`	`6`	`name="shell",`
	`7`	`+ skip_shellcheck=True,`
`7`	`8`	`)`
Original file line number	Diff line number	Diff line change
`@@ -5,4 +5,5 @@ python_sources(`
`5`	`5`	`shell_sources(`
`6`	`6`	`name="shell",`
`7`	`7`	`sources=["st2ctl", "st2-self-check", "st2-run-pack-tests"],`
	`8`	`+ skip_shellcheck=True,`
`8`	`9`	`)`
Original file line number	Diff line number	Diff line change
`@@ -6,4 +6,5 @@ shell_sources(`
`6`	`6`	`"*.sh",`
`7`	`7`	`"st2-setup-*",`
`8`	`8`	`],`
	`9`	`+ skip_shellcheck=True,`
`9`	`10`	`)`