Compare commits

...

74 Commits

Author SHA1 Message Date
Antonio Gonzalez Gea
00b27aa7cb
Update actions/checkout version on README.md (#101) 2024-06-20 09:15:00 +02:00
dependabot[bot]
cd81f4475a
Bump actions/checkout from 3 to 4.1.0 (#95)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Joakim Sørensen <hi@ludeeus.dev>
2023-10-08 17:52:30 +02:00
Joakim Sørensen
00cae500b0
Remove non-working problem matchers. (#88) 2023-01-29 17:39:54 +01:00
Joakim Sørensen
84dc45371e
Remove problem matchers before exit (#86) 2023-01-29 16:46:47 +01:00
Joakim Sørensen
e07831dc6f
Set 0.9.0 as example version (#85) 2023-01-29 16:35:31 +01:00
Joakim Sørensen
c4b2ed0185
Add basic devcontainer (#84) 2023-01-29 16:34:46 +01:00
Reid Price
e5c9260d11
README: suggest use of line folding (#82)
Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
2023-01-28 21:53:27 +01:00
Joakim Sørensen
6d3f514f44
Add dependabot config for actions (#77) 2022-11-06 20:58:36 +01:00
Joakim Sørensen
0b28ced3b4
Bump actions/checkout to v3 (#76) 2022-11-06 20:56:54 +01:00
Joakim Sørensen
3261165459
Limit PR actions to master (#75) 2022-11-06 20:50:21 +01:00
Joakim Sørensen
1e1da5dfe2
Add permissions key to workflows and example (#74) 2022-11-06 20:47:49 +01:00
Joakim Sørensen
be27f35867
Add back display version (#73) 2022-11-06 20:43:35 +01:00
Joakim Sørensen
6b1b9b1437
Remove debug messages (#72) 2022-11-06 20:37:00 +01:00
Joakim Sørensen
3d0de11d23
Use INPUT_* for input env to match documentation (#71) 2022-11-06 20:34:02 +01:00
Boris Bera
45e81d0a30
Pass inputs to env before reading (#66)
Co-authored-by: Joakim Sørensen <hi@ludeeus.dev>
2022-11-06 20:17:51 +01:00
Matthew Boston
9634fec4ed
Replace deprecated set-output (#70)
Co-authored-by: Joakim Sørensen <hi@ludeeus.dev>
2022-11-06 19:52:23 +01:00
ludeeus
1c879e7d68 Remove releasedrafter action 2022-11-06 19:50:00 +01:00
Joakim Sørensen
b2bbefc2e6
Deprecate ignore (#68) 2022-09-03 08:53:15 +00:00
Joakim Sørensen
20fbf19cec
Cleanup debug information (#67) 2022-09-03 10:45:55 +02:00
Arkadiusz Bokowy
10434c2598
Fix warnings reported by shellcheck (#61)
Co-authored-by: Joakim Sørensen <hi@ludeeus.dev>
2022-09-03 10:31:50 +02:00
bi1yeu
6096f68baf
Exact path matching ignore path (#59)
* support exact path matching and glob matching for ignore_path

* newlines

* update readme

* Trigger CI

Co-authored-by: ludeeus <ludeeus@ludeeus.dev>
2022-09-03 10:29:32 +02:00
Joakim Sørensen
203a3fd018
Add separate matcher for note to transform to notice (#53) 2021-11-14 11:48:26 +01:00
Joakim Sørensen
c2b45ddc5f
Split ignore into ignore_paths and ignore_names (#52) 2021-11-14 11:01:29 +01:00
Joakim Sørensen
2e033faa4a
Remove checking subdir and suffix for bin (#51) 2021-11-14 10:30:44 +01:00
Joakim Sørensen
0ef4a19bfe
Use "version" instead of "shellcheck_version" for the input (#50) 2021-11-14 10:21:33 +01:00
Phred Lane
a1080136d9
Updated matchers to account for "./" file prefixes (#42)
Co-authored-by: Joakim Sørensen <hi@ludeeus.dev>
2021-11-14 10:10:45 +01:00
Milan Vit
7606914ded
Allow specifying ShellCheck version (#44)
Co-authored-by: Joakim Sørensen <hi@ludeeus.dev>
2021-11-14 10:10:08 +01:00
Benoit
ceeca77f65
Do not run shellcheck on zsh scripts. (#48)
Co-authored-by: Joakim Sørensen <hi@ludeeus.dev>
2021-11-01 10:08:12 +01:00
Linus Gasser
8379299538
typo (#47) 2021-11-01 10:02:27 +01:00
Alexey Alekhin
94e0aab03c
feat: add format input and a single-line problem matcher (#40)
Co-authored-by: Joakim Sørensen <ludeeus@gmail.com>
2021-03-31 21:03:27 +02:00
Ludeeus
184a772465 Use correct branch for release-drafter 2021-03-31 20:53:27 +02:00
Ludeeus
f01a9171d3 Add Release Drafter 2021-03-31 20:52:44 +02:00
Alexey Alekhin
7fa8ae9d42
fix: multiline problem matcher (#39) 2021-03-31 15:55:33 +02:00
Josh Soref
f0d446b80e
spelling: separated (#37)
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2021-02-11 10:30:11 +01:00
Viktor Szépe
00209834e5
Add Display shellcheck version step (#36) 2021-01-16 23:47:30 +01:00
Justin Hammond
ac3e5d1ab4
Updates README to include ShellCheck flag/options usage (#35) 2021-01-13 18:26:27 +01:00
Simon Egersand
b247a9c05d
Add ignore multiple dirs example (#33) 2020-12-24 12:06:42 +01:00
Ludeeus
d586102c11 Fix substitution issue 2020-10-25 21:06:05 +01:00
Joakim Sørensen
02daeb3604
Move action to composite (#31) 2020-10-25 21:00:46 +01:00
Daniel
fcee962fee
Add scandir option (#28) 2020-10-03 14:49:12 +02:00
Joakim Sørensen
c489c81f79
Re enable problem-matcher (#25) 2020-07-28 14:21:49 +02:00
pvogt09
73cbb64041
Fixes issues with globbing files with partial match(#23)
Co-authored-by: Joakim Sørensen <hi@ludeeus.dev>
2020-07-28 13:54:55 +02:00
Tom Riat
c7d4e499f1
Update action checkout to the new default branch (#24)
Co-authored-by: Joakim Sørensen <hi@ludeeus.dev>
2020-07-28 10:59:37 +02:00
Oscar Tin Lai
7ee62c0418
Enable shellcheck for shebang with /bin/env (#22)
Co-authored-by: Joakim Sørensen <hi@ludeeus.dev>
2020-07-14 20:39:58 +02:00
Joakim Sørensen
2394c9008b
Remove problem matcher
Fixes #21
2020-07-14 20:29:42 +02:00
Joakim Sørensen
637bb438ec
Adds problem-matcher (#20)
* Adds problem-matcher

* Fix issue

* match as group 1

* use message

* Limit output

* remove testfile
2020-07-05 23:50:07 +02:00
ludeeus
2f2aa0d97f
Update alpine to 3.12.0 2020-06-27 19:42:52 +02:00
Daniel
c79c26d324
Add filetype to find command (#19)
This fixes an error when a directory contains "bash" in the name. This
would lead to a shellcheck on a directory and crash.
2020-06-27 11:43:04 +02:00
Brandon W Maister
35d6c4c933
Add the ability to check all scripts in one shellcheck command (#17)
This is the most straightforward way to allow sourcing scripts, as shellcheck
[SC1090] only allows `source` files that are in the same invocation, I believe
unless `-x` is also specified.

[SC1090]: https://github.com/koalaman/shellcheck/wiki/SC1090
2020-06-26 21:41:45 +02:00
Ilir Bekteshi
142c6d53df
Add severity input (#16)
Co-authored-by: Joakim Sørensen <hi@ludeeus.dev>
2020-06-26 08:05:34 +02:00
Joakim Sørensen
06cf1c7f5d
Update and rename push.yml to ShellCheck.yml 2020-06-25 12:20:30 +02:00
Gareth Healy
513f424cc7
Added mvnw to excludes (#15) 2020-06-10 11:56:06 +02:00
ludeeus
fbd26dc426 Exclude go and profile 2020-06-07 16:53:52 +02:00
Joakim Sørensen
f22efe748c
Merge pull request #13 from ludeeus/testfiles
Add exclude and testfiles
2020-05-30 12:02:57 +02:00
ludeeus
b44aa9b87a Update 2020-05-30 12:02:32 +02:00
ludeeus
acc4e4fe97 take both 2020-05-30 12:01:39 +02:00
ludeeus
6eb62923bc Update 2020-05-30 12:00:24 +02:00
ludeeus
3a4806a465 Update readme 2020-05-30 11:57:50 +02:00
ludeeus
21696cbf1a simplify 2020-05-30 11:55:03 +02:00
ludeeus
fa3cc6ede4 Use self 2020-05-30 11:46:07 +02:00
ludeeus
18c29dd450 Add exclude and testfiles 2020-05-30 11:44:01 +02:00
ludeeus
c07d062aa5 Fix remnants of tests 2020-05-30 00:12:17 +02:00
ludeeus
a1eeadd7ec Add back bash 2020-05-30 00:06:50 +02:00
ludeeus
f615dc5486 restructure 2020-05-30 00:06:39 +02:00
ludeeus
b443c466bf Remove bash 2020-05-29 23:13:38 +02:00
ludeeus
35efb355bc Update README 2020-05-29 23:11:34 +02:00
ludeeus
5e7f90b47a Move image to alpine 2020-05-29 23:11:06 +02:00
Joakim Sørensen
70c0c19934
Merge pull request #10 from cramte/fix-runaction-exitcode
Fix runaction.sh return values
2020-05-05 08:29:47 +02:00
cramte
9f3543661d Fix runaction.sh return values 2020-05-03 22:11:15 +02:00
Joakim Sørensen
746dd2ddc0
Merge pull request #4 from kurahaupo/patch-1
apply to all Bash, Ksh, Zsh & POSIX Shell files
2019-12-01 10:17:06 +01:00
Joakim Sørensen
88a963fbeb
Merge pull request #2 from tchia04/migrate_to_yml
converted main.workflow to Actions V2 yml files
2019-11-29 22:30:12 +01:00
Martin Kealey
2e9d4c556d
Update runaction.sh 2019-11-20 16:56:37 +11:00
Martin Kealey
9445381284
apply to all Bash, Ksh, Zsh & POSIX Shell files
Does not need bash to run; standard posix sh suffices.

Apply shellcheck to:

* files with shbang lines that indicate a shell (sh, bash, ash, bsh, ksh, zsh)

* typical home directory shell startup files:
  for posix sh & all shells: .profile
  for bash: .bashrc, .bash_aliases, .bash_completion, .bash_login, .bash_logout, .bash_profile
  for ksh: .profile
  for zsh: .zprofile, .zlogin, .zlogout, .zshenv, .zshrc

* typical system-wide shell startup files:
  for posix sh & all shells: /etc/profile
  for bash: /etc/bashrc, /etc/bash_profile
  for ksh:
  for zsh: /etc/zprofile, /etc/zlogin, /etc/zlogout, /etc/zshenv, /etc/zshrc

* files with suffixes: .bash, .zsh, .ksh, & .sh
2019-11-20 16:45:19 +11:00
Tony Chia
370adf4cb6 converted main.workflow to Actions V2 yml files 2019-09-18 13:28:56 -07:00
32 changed files with 763 additions and 47 deletions

4
.devcontainer.json Normal file
View File

@ -0,0 +1,4 @@
{
"name": "ludeeus/action-shellcheck",
"image": "mcr.microsoft.com/devcontainers/base:bullseye"
}

1
.gitattributes vendored Normal file
View File

@ -0,0 +1 @@
* text=auto eol=lf

1
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1 @@
blank_issues_enabled: false

View File

@ -0,0 +1,24 @@
---
name: Feature request
about: Suggest an idea for this project
labels: "Feature Request"
---
## Checklist
- [ ] This Feature Request only contains 1 request (if you have multiple open multiple feature requests).
## The idea
A good description of what you are suggesting.
## Implementation
How do you see this being implemented?
## Alternatives
Are there any alternative solutions or features you've considered?
## Additional context

14
.github/ISSUE_TEMPLATE/issue.md vendored Normal file
View File

@ -0,0 +1,14 @@
---
name: "Issue"
about: For issue reporting.
labels: "bug"
---
## Describe the issue
A clear and concise description of what the issue is.
### Links
- **Link to action run:**
- **Link to action configuration:**

8
.github/dependabot.yml vendored Normal file
View File

@ -0,0 +1,8 @@
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: weekly
time: "06:00"
open-pull-requests-limit: 10

View File

@ -1,8 +0,0 @@
workflow "Trigger: Push" {
on = "push"
resolves = ["Shellcheck"]
}
action "Shellcheck" {
uses = "ludeeus/action-shellcheck@master"
}

47
.github/workflows/additional_files.yml vendored Normal file
View File

@ -0,0 +1,47 @@
name: 'additional_files'
on:
push:
branches:
- "master"
pull_request:
branches:
- "master"
permissions: {}
jobs:
additional_files:
name: additional_files
runs-on: ${{ matrix.os }}
strategy:
matrix:
os:
- ubuntu-latest
- macos-latest
steps:
- name: Checkout
uses: actions/checkout@v4.1.0
- name: Run ShellCheck
uses: ./
id: check
with:
additional_files: run finish discovery
ignore_paths: ignore
scandir: testfiles
- name: Verify check
run: |
expect="testfiles/scandir/run"
if [[ ! "${{ steps.check.outputs.files }}" =~ testfiles/scandir/run ]];then
echo "::error:: Expected file testfiles/scandir/run not found in ${{ steps.check.outputs.files }}"
exit 1
elif [[ ! "${{ steps.check.outputs.files }}" =~ testfiles/scandir/finish ]];then
echo "::error:: Expected file testfiles/scandir/finish not found in ${{ steps.check.outputs.files }}"
exit 1
elif [[ ! "${{ steps.check.outputs.files }}" =~ testfiles/scandir/discovery ]];then
echo "::error:: Expected file testfiles/scandir/discovery not found in ${{ steps.check.outputs.files }}"
exit 1
fi

44
.github/workflows/check_together.yml vendored Normal file
View File

@ -0,0 +1,44 @@
name: 'check_together'
on:
push:
branches:
- "master"
pull_request:
branches:
- "master"
permissions: {}
jobs:
check_together:
name: check_together
runs-on: ${{ matrix.os }}
strategy:
matrix:
os:
- ubuntu-latest
- macos-latest
steps:
- name: Checkout
uses: actions/checkout@v4.1.0
- name: Run ShellCheck
uses: ./
id: check
with:
ignore_paths: ignore
check_together: true
- name: Verify check
run: |
expect="testfiles/test.bash"
notexpect="testfiles/ignore/ignore.bash"
if [[ ! "${{ steps.check.outputs.files }}" =~ $expect ]];then
echo "::error:: Expected file $expect not found in ${{ steps.check.outputs.files }}"
exit 1
elif [[ "${{ steps.check.outputs.files }}" =~ $notexpect ]];then
echo "::error:: Expected file $notexpect found in ${{ steps.check.outputs.files }}"
exit 1
fi

44
.github/workflows/ignore_names.yml vendored Normal file
View File

@ -0,0 +1,44 @@
name: 'ignore_names'
on:
push:
branches:
- "master"
pull_request:
branches:
- "master"
permissions: {}
jobs:
ignore_names:
name: ignore_names
runs-on: ${{ matrix.os }}
strategy:
matrix:
os:
- ubuntu-latest
- macos-latest
steps:
- name: Checkout
uses: actions/checkout@v4.1.0
- name: Run ShellCheck
uses: ./
id: check
with:
ignore_paths: ignore
ignore_names: ignore_single_file.sh
- name: Verify check
run: |
expect="testfiles/test.bash"
notexpect="testfiles/ignore_single_file.sh"
if [[ ! "${{ steps.check.outputs.files }}" =~ $expect ]];then
echo "::error:: Expected file $expect not found in ${{ steps.check.outputs.files }}"
exit 1
elif [[ "${{ steps.check.outputs.files }}" =~ $notexpect ]];then
echo "::error:: Expected file $notexpect found in ${{ steps.check.outputs.files }}"
exit 1
fi

74
.github/workflows/ignore_paths.yml vendored Normal file
View File

@ -0,0 +1,74 @@
name: "ignore_paths"
on:
push:
branches:
- "master"
pull_request:
branches:
- "master"
permissions: {}
jobs:
ignore_paths:
name: ignore_paths
runs-on: ${{ matrix.os }}
strategy:
matrix:
os:
- ubuntu-latest
- macos-latest
steps:
- name: Checkout
uses: actions/checkout@v4.1.0
- name: Run ShellCheck
uses: ./
id: check
with:
ignore_paths: ignore ./testfiles/ignore_some/duplicate_name.bash **/ignore_some/ignore.bash
- name: Verify check
run: |
fail=false
# verify a non-ignored path is not excluded
expect="testfiles/test.bash"
if [[ ! "${{ steps.check.outputs.files }}" =~ $expect ]];then
echo "::error:: Expected file $expect not found in ${{ steps.check.outputs.files }}"
fail=true
fi
# verify a file with the same name as an ignored file but at a
# different path is not excluded
expect="testfiles/duplicate_name.bash"
if [[ ! "${{ steps.check.outputs.files }}" =~ $expect ]];then
echo "::error:: Expected file $expect not found in ${{ steps.check.outputs.files }}"
fail=true
fi
# verify ignored full path excluded
notexpect="testfiles/ignore_some/duplicate_name.bash"
if [[ "${{ steps.check.outputs.files }}" =~ $notexpect ]];then
echo "::error:: Unexpected file $notexpect found in ${{ steps.check.outputs.files }}"
fail=true
fi
# verify ignored directory excluded
notexpect="testfiles/ignore/ignore.bash"
if [[ "${{ steps.check.outputs.files }}" =~ $notexpect ]];then
echo "::error:: Unexpected file $notexpect found in ${{ steps.check.outputs.files }}"
fail=true
fi
# verify ignored glob excluded
notexpect="testfiles/ignore_some/ignore.bash"
if [[ "${{ steps.check.outputs.files }}" =~ $notexpect ]];then
echo "::error:: Unexpected file $notexpect found in ${{ steps.check.outputs.files }}"
fail=true
fi
if $fail;then
exit 1
fi

63
.github/workflows/scandir.yml vendored Normal file
View File

@ -0,0 +1,63 @@
name: 'scandir'
on:
push:
branches:
- "master"
pull_request:
branches:
- "master"
permissions: {}
jobs:
scandir:
name: scandir
runs-on: ${{ matrix.os }}
strategy:
matrix:
os:
- ubuntu-latest
- macos-latest
steps:
- name: Checkout
uses: actions/checkout@v4.1.0
- name: Run ShellCheck
uses: ./
id: one
with:
scandir: testfiles/scandir
- name: Verify check
run: |
expect="testfiles/scandir/run[[:space:]]me.bash"
notexpect="testfiles/test.bash"
if [[ ! "${{ steps.one.outputs.files }}" =~ $expect ]];then
echo "::error:: Expected file $expect not found in ${{ steps.one.outputs.files }}"
exit 1
elif [[ "${{ steps.one.outputs.files }}" =~ $notexpect ]];then
echo "::error:: Expected file $notexpect found in ${{ steps.one.outputs.files }}"
exit 1
fi
- name: Run ShellCheck
uses: ./
id: two
with:
scandir: './testfiles/scandir'
ignore_paths: ignore
- name: Verify check
run: |
expect="testfiles/scandir/test.bash"
notexpect="testfiles/test.bash"
if [[ ! "${{ steps.two.outputs.files }}" =~ $expect ]];then
echo "::error:: Expected file $expect not found in ${{ steps.two.outputs.files }}"
exit 1
elif [[ "${{ steps.two.outputs.files }}" =~ $notexpect ]];then
echo "::error:: Expected file $notexpect found in ${{ steps.two.outputs.files }}"
exit 1
fi

View File

@ -1,16 +0,0 @@
FROM debian:latest
COPY runaction.sh /runaction.sh
RUN chmod +x /runaction.sh
RUN apt update
RUN apt install -y shellcheck
ENTRYPOINT ["/runaction.sh"]
LABEL "name"="shellcheck"
LABEL "maintainer"="Ludeeus <ludeeus@gmail.com>"
LABEL "version"="0.1.0"
LABEL "com.github.actions.name"="shellcheck"
LABEL "com.github.actions.description"="Run shell check on ALL sh files in the repository."
LABEL "com.github.actions.icon"="terminal"
LABEL "com.github.actions.color"="black"

View File

@ -1,6 +1,6 @@
MIT License
Copyright (c) 2019 ludeeus
Copyright (c) 2020 ludeeus
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

176
README.md
View File

@ -1,24 +1,168 @@
# SHELLCHECK
# ShellCheck
[![BuyMeCoffee][buymecoffeebedge]][buymecoffee]
_Run shellcheck on ALL sh files in the repository._
_GitHub action for [ShellCheck](https://www.shellcheck.net/)._
## Example
```
workflow "Shellcheck" {
on = "push"
resolves = [
"Shellcheck",
]
}
```yaml
on:
push:
branches:
- master
name: "Trigger: Push action"
permissions: {}
action "Shellcheck" {
uses = "ludeeus/actions/shellcheck@master"
}
jobs:
shellcheck:
name: Shellcheck
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Run ShellCheck
uses: ludeeus/action-shellcheck@master
```
[buymecoffee]: https://www.buymeacoffee.com/ludeeus
[buymecoffeebedge]: https://camo.githubusercontent.com/cd005dca0ef55d7725912ec03a936d3a7c8de5b5/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6275792532306d6525323061253230636f666665652d646f6e6174652d79656c6c6f772e737667
## ShellCheck options
You can pass any supported ShellCheck option or flag with the `SHELLCHECK_OPTS` env key in the job definition.
Some examples include:
- To disable specific checks (eg: `-e SC2059 -e SC2034 -e SC1090`)
- To test against different shells (eg: `-s dash` or `-s ksh`)
example:
```yaml
...
- name: Run ShellCheck
uses: ludeeus/action-shellcheck@master
env:
SHELLCHECK_OPTS: -e SC2059 -e SC2034 -e SC1090
```
## Ignore paths and names
You can use the `ignore_paths` and `ignore_names` input to disable specific directories and files.
These are passed as environment variables, and should evaluate to a single space-separated string.
It may be convenient to use [`>-`](https://yaml.org/spec/1.2.2/#65-line-folding) for readability if you have multiple selectors.
```text
sample structure:
sample/directory/with/files/ignoreme/test.sh
sample/directory/with/files/ignoremetoo/test.sh
sample/directory/with/files/test.sh
sample/directory/with/files/ignorable.sh
```
example:
```yaml
...
- name: Run ShellCheck
uses: ludeeus/action-shellcheck@master
with:
ignore_paths: >-
ignoreme
ignoremetoo
ignore_names: ignorable.sh
```
This will skip `sample/directory/with/files/ignoreme/test.sh`, `sample/directory/with/files/ignoremetoo/test.sh` and `sample/directory/with/files/ignorable.sh`.
You can also ignore specific files using full paths or glob patterns with `ignore_paths`.
example:
```yaml
...
- name: Run ShellCheck
uses: ludeeus/action-shellcheck@master
with:
ignore_paths: ./sample/directory/with/files/ignorable.sh **/ignoreme/test.sh
```
This will skip `sample/directory/with/files/ignorable.sh` and `sample/directory/with/files/ignoreme/test.sh`.
## Minimum severity of errors to consider (error, warning, info, style)
You can use the `severity` input to not fail until specified severity is met, for example fail only if there are errors in scripts but ignore styling, info and warnings.
example:
```yaml
...
- name: Run ShellCheck
uses: ludeeus/action-shellcheck@master
with:
severity: error
```
## Run shellcheck with all paths in a single invocation
If you run into SC1090/SC1091 errors you may need to tell shellcheck to check
all files at once:
```yaml
...
- name: Run ShellCheck
uses: ludeeus/action-shellcheck@master
with:
check_together: 'yes'
```
This can turn into a problem if you have enough script files to overwhelm the
maximum argv length on your system.
## Run shellcheck only in a single directory
If you have multiple directories with scripts, but only want to scan
one of them, you can use the following configuration:
```yaml
...
- name: Run ShellCheck
uses: ludeeus/action-shellcheck@master
with:
scandir: './scripts'
```
## Scan for additional files
If you need to scan for unusual files, you can use the `additional_files` key.
```yaml
...
- name: Run ShellCheck
uses: ludeeus/action-shellcheck@master
with:
additional_files: 'run finish'
```
## Change output format
Shellcheck can print output in these formats: `checkstyle`, `diff`, `gcc`, `json`, `json1`, `quiet`, `tty`. See some examples [here](https://github.com/koalaman/shellcheck/wiki/Integration#pick-the-output-format-that-makes-your-life-easier).
- `tty` has multi-line log messages
- `gcc` has single-line log messages
```yaml
...
- name: Run ShellCheck
uses: ludeeus/action-shellcheck@master
with:
format: tty
```
## Run a specific version of Shellcheck
If running the latest stable version of Shellcheck is not to your liking, you can specify a concrete version of Shellcheck to be used. When specifying a custom version, please use any of the released versions listed in the [Shellcheck repository](https://github.com/koalaman/shellcheck/tags).
```yaml
...
- name: Run ShellCheck
uses: ludeeus/action-shellcheck@master
with:
version: v0.9.0
```

225
action.yaml Normal file
View File

@ -0,0 +1,225 @@
name: "ShellCheck"
author: "Ludeeus <hi@ludeeus.dev>"
description: "GitHub action for ShellCheck."
inputs:
additional_files:
description: "A space separated list of additional filename to check"
required: false
default: ""
ignore:
description: "Paths to ignore when running ShellCheck"
required: false
default: ""
deprecationMessage: "Use ignore_paths or ignore_names instead."
ignore_paths:
description: "Paths to ignore when running ShellCheck"
required: false
default: ""
ignore_names:
description: "Names to ignore when running ShellCheck"
required: false
default: ""
severity:
description: "Minimum severity of errors to consider. Options: [error, warning, info, style]"
required: false
default: ""
check_together:
description: "Run shellcheck on _all_ files at once, instead of one at a time"
required: false
default: ""
scandir:
description: "Directory to be searched for files. Defaults to ."
required: false
default: "."
disable_matcher:
description: "Set to true to skip using problem-matcher"
required: false
default: "false"
deprecationMessage: "There are no problem-matchers, this setting does not do anything."
format:
description: "Output format (checkstyle, diff, gcc, json, json1, quiet, tty)"
required: false
default: "gcc"
version:
description: "Specify a concrete version of ShellCheck to use"
required: false
default: "stable"
outputs:
files:
description: A list of files with issues
value: ${{ steps.check.outputs.filepaths }}
options:
description: The options used
value: ${{ steps.options.outputs.options }}
branding:
icon: "terminal"
color: "gray-dark"
runs:
using: "composite"
steps:
- name: Download shellcheck
shell: bash
env:
INPUT_VERSION: ${{ inputs.version }}
run: |
if [[ "${{ runner.os }}" == "macOS" ]]; then
osvariant="darwin"
else
osvariant="linux"
fi
baseurl="https://github.com/koalaman/shellcheck/releases/download"
curl -Lso "${{ github.action_path }}/sc.tar.xz" \
"${baseurl}/${INPUT_VERSION}/shellcheck-${INPUT_VERSION}.${osvariant}.x86_64.tar.xz"
tar -xf "${{ github.action_path }}/sc.tar.xz" -C "${{ github.action_path }}"
mv "${{ github.action_path }}/shellcheck-${INPUT_VERSION}/shellcheck" \
"${{ github.action_path }}/shellcheck"
- name: Display shellcheck version
shell: bash
run: |
"${{ github.action_path }}/shellcheck" --version
- name: Set options
shell: bash
id: options
env:
INPUT_SEVERITY: ${{ inputs.severity }}
INPUT_FORMAT: ${{ inputs.format }}
run: |
declare -a options
if [[ -n "${INPUT_SEVERITY}" ]]; then
options+=("-S ${INPUT_SEVERITY}")
fi
options+=("--format=${INPUT_FORMAT}")
echo "options=${options[@]}" >> $GITHUB_OUTPUT
- name: Gather excluded paths
shell: bash
id: exclude
env:
INPUT_IGNORE: ${{ inputs.ignore }}
INPUT_IGNORE_PATHS: ${{ inputs.ignore_paths }}
INPUT_IGNORE_NAMES: ${{ inputs.ignore_names }}
run: |
declare -a excludes
set -f # temporarily disable globbing so that globs in input aren't expanded
excludes+=("! -path *./.git/*")
excludes+=("! -path *.go")
excludes+=("! -path */mvnw")
if [[ -n "${INPUT_IGNORE}" ]]; then
for path in ${INPUT_IGNORE}; do
excludes+=("! -path *./$path/*")
excludes+=("! -path */$path/*")
excludes+=("! -path $path")
done
else
for path in ${INPUT_IGNORE_PATHS}; do
excludes+=("! -path *./$path/*")
excludes+=("! -path */$path/*")
excludes+=("! -path $path")
done
fi
for name in ${INPUT_IGNORE_NAMES}; do
excludes+=("! -name $name")
done
echo "excludes=${excludes[@]}" >> $GITHUB_OUTPUT
set +f # re-enable globbing
- name: Gather additional files
shell: bash
id: additional
env:
INPUT_ADDITIONAL_FILES: ${{ inputs.additional_files }}
run: |
declare -a files
for file in ${INPUT_ADDITIONAL_FILES}; do
files+=("-o -name *$file")
done
echo "files=${files[@]}" >> $GITHUB_OUTPUT
- name: Run the check
shell: bash
id: check
env:
INPUT_SCANDIR: ${{ inputs.scandir }}
INPUT_CHECK_TOGETHER: ${{ inputs.check_together }}
INPUT_EXCLUDE_ARGS: ${{ steps.exclude.outputs.excludes }}
INPUT_ADDITIONAL_FILE_ARGS: ${{ steps.additional.outputs.files }}
INPUT_SHELLCHECK_OPTIONS: ${{ steps.options.outputs.options }}
run: |
statuscode=0
declare -a filepaths
shebangregex="^#! */[^ ]*/(env *)?[abk]*sh"
set -f # temporarily disable globbing so that globs in inputs aren't expanded
while IFS= read -r -d '' file; do
filepaths+=("$file")
done < <(find "${INPUT_SCANDIR}" \
${INPUT_EXCLUDE_ARGS} \
-type f \
'(' \
-name '*.bash' \
-o -name '.bashrc' \
-o -name 'bashrc' \
-o -name '.bash_aliases' \
-o -name '.bash_completion' \
-o -name '.bash_login' \
-o -name '.bash_logout' \
-o -name '.bash_profile' \
-o -name 'bash_profile' \
-o -name '*.ksh' \
-o -name 'suid_profile' \
-o -name '*.zsh' \
-o -name '.zlogin' \
-o -name 'zlogin' \
-o -name '.zlogout' \
-o -name 'zlogout' \
-o -name '.zprofile' \
-o -name 'zprofile' \
-o -name '.zsenv' \
-o -name 'zsenv' \
-o -name '.zshrc' \
-o -name 'zshrc' \
-o -name '*.sh' \
-o -path '*/.profile' \
-o -path '*/profile' \
-o -name '*.shlib' \
${INPUT_ADDITIONAL_FILE_ARGS} \
')' \
-print0)
while IFS= read -r -d '' file; do
head -n1 "$file" | grep -Eqs "$shebangregex" || continue
filepaths+=("$file")
done < <(find "${INPUT_SCANDIR}" \
${INPUT_EXCLUDE_ARGS} \
-type f ! -name '*.*' -perm /111 \
-print0)
if [[ -n "${INPUT_CHECK_TOGETHER}" ]]; then
"${{ github.action_path }}/shellcheck" \
${INPUT_SHELLCHECK_OPTIONS} \
"${filepaths[@]}" || statuscode=$?
else
for file in "${filepaths[@]}"; do
"${{ github.action_path }}/shellcheck" \
${INPUT_SHELLCHECK_OPTIONS} \
"$file" || statuscode=$?
done
fi
echo "filepaths=${filepaths[@]}" >> $GITHUB_OUTPUT
echo "statuscode=$statuscode" >> $GITHUB_OUTPUT
set +f # re-enable globbing
- name: Exit action
shell: bash
run: exit ${{steps.check.outputs.statuscode}}

View File

@ -1,6 +0,0 @@
#!/bin/bash
cd "$GITHUB_WORKSPACE" || exit 1
find . -name \*.sh -exec shellcheck {} +
find . -name \*.bashrc -exec shellcheck {} +
find . -name \*.bash_profile -exec shellcheck {} +

6
testfiles/bashfile.c Normal file
View File

@ -0,0 +1,6 @@
/* C code test file
* file that should not be matched for shellcheck runs
*/
int main(void) {
return 0;
}

View File

@ -0,0 +1,3 @@
#!/bin/bash
test="test"
echo "$test"

View File

@ -0,0 +1,3 @@
#!/bin/bash
test="test"
echo "$test"

View File

@ -0,0 +1,4 @@
#!/usr/bin/sh
test="test"
echo "$test"

View File

@ -0,0 +1,3 @@
#!/bin/bash
test="test"
echo "$test"

View File

@ -0,0 +1,3 @@
#!/bin/bash
test="test"
echo "$test"

View File

@ -0,0 +1,3 @@
#!/bin/bash
test="test"
echo "$test"

View File

@ -0,0 +1,3 @@
#!/usr/bin/env bashio
echo "hi"

5
testfiles/scandir/finish Normal file
View File

@ -0,0 +1,5 @@
#!/usr/bin/env bashio
hi="hi"
echo "$hi"

3
testfiles/scandir/run Normal file
View File

@ -0,0 +1,3 @@
#!/usr/bin/env bash
echo "hi"

View File

@ -0,0 +1,3 @@
#!/usr/bin/env bash
echo "I love spaces"

View File

@ -0,0 +1,3 @@
#!/bin/bash
test="test"
echo "$test"

4
testfiles/test Normal file
View File

@ -0,0 +1,4 @@
#!/bin/bash
test="test"
echo "$test"

3
testfiles/test.bash Normal file
View File

@ -0,0 +1,3 @@
#!/bin/bash
test="test"
echo "$test"

4
testfiles/test.sh Normal file
View File

@ -0,0 +1,4 @@
#!/usr/bin/sh
test="test"
echo "$test"