Merge pull request #13 from ludeeus/testfiles

Add exclude and testfiles

.gitattributes

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

.github/main.workflow

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

.github/workflows/push.yml

@@ -0,0 +1,13 @@
+on: push
+name: 'Trigger: Push'
+jobs:
+  shellcheck:
+    name: ShellCheck
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@master
+    - name: Run ShellCheck
+      uses: ./
+      with:
+        ignore: ignore

Dockerfile

@@ -1,16 +1,6 @@
-FROM debian:latest
+FROM alpine:3.11.6
 
-COPY runaction.sh /runaction.sh
-RUN chmod +x /runaction.sh
-RUN apt update
-RUN apt install -y shellcheck
+RUN apk add --no-cache shellcheck bash
 
-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"
+COPY runaction.sh /action/runaction.sh
+ENTRYPOINT ["bash", "/action/runaction.sh"]

README.md

@@ -1,24 +1,59 @@
-# SHELLCHECK
+# ShellCheck
 
-[![BuyMeCoffee][buymecoffeebedge]][buymecoffee]
-
-_Run shellcheck on ALL sh files in the repository._
+_GitHub action for ShellCheck._
 
 ## Example
 
-```
-workflow "Shellcheck" {
-  on = "push"
-  resolves = [
-    "Shellcheck",
-  ]
-}
+```yaml
+on: 
+  push:
+    branch:
+      - master
 
+name: 'Trigger: Push action'
 
-action "Shellcheck" {
-  uses = "ludeeus/actions/shellcheck@master"
-}
+jobs:
+  shellcheck:
+    name: Shellcheck
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: Run ShellCheck
+      uses: ludeeus/action-shellcheck@master
 ```
 
-[buymecoffee]: https://www.buymeacoffee.com/ludeeus
-[buymecoffeebedge]: https://camo.githubusercontent.com/cd005dca0ef55d7725912ec03a936d3a7c8de5b5/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6275792532306d6525323061253230636f666665652d646f6e6174652d79656c6c6f772e737667
+## Globally disable checks
+
+To disable specific checks add it to a `SHELLCHECK_OPTS` env key in the job definition.
+
+example:
+
+```yaml
+    ...
+    - name: Run ShellCheck
+      uses: ludeeus/action-shellcheck@master
+      env:
+        SHELLCHECK_OPTS: -e SC2059 -e SC2034 -e SC1090
+```
+
+## Ignore paths
+
+You can use the `ignore` input to disable specific directories.
+
+```text
+sample structure:
+sample/directory/with/files/toignore/test.sh
+sample/directory/with/files/test.sh
+```
+
+example:
+
+```yaml
+    ...
+    - name: Run ShellCheck
+      uses: ludeeus/action-shellcheck@master
+      with:
+        ignore: toignore
+```
+
+This will skip `sample/directory/with/files/toignore/test.sh`

action.yaml

@@ -0,0 +1,14 @@
+name: "ShellCheck"
+author: "Ludeeus <hi@ludeeus.dev>"
+description: "GitHub action for ShellCheck."
+inputs:
+  ignore:
+    description: 'Paths to ignore when running ShellCheck'
+    required: false
+    default: ''
+runs: 
+  using: 'docker'
+  image: 'Dockerfile'
+branding:
+  icon: 'terminal'  
+  color: 'gray-dark'

runaction.sh

@@ -1,6 +1,72 @@
 #!/bin/bash
 
 cd "$GITHUB_WORKSPACE" || exit 1
-find . -name \*.sh -exec shellcheck {} +
-find . -name \*.bashrc -exec shellcheck {} +
-find . -name \*.bash_profile -exec shellcheck {} +
+
+declare statuscode
+declare -a filepaths
+declare -a excludes
+declare -a tmp
+
+statuscode=0
+
+excludes+=( ! -path *./.git/* )
+for path in ${INPUT_IGNORE}; do
+    echo "::debug:: Adding '${path}' to excludes"
+    excludes+=(! -path "*./${path}/*" )
+    excludes+=(! -path "*/${path}/*" )
+done
+
+readarray -d '' filepaths < <(find . "${excludes[@]}" \
+    '(' \
+    \
+    -name '*.bash' \
+    -o -path '*/.bash*' \
+    -o -path '*/bash*' \
+    -o -name '*.ksh' \
+    -o -name 'ksh*' \
+    -o -path '*/.ksh*' \
+    -o -path '*/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 -path '*/.zsh*' \
+    -o -path '*/zsh*' \
+    -o -name '*.sh' \
+    -o -path '*/.profile*' \
+    -o -path '*/profile*' \
+    -o -path '*/.shlib*' \
+    -o -path '*/shlib*' \
+       ')'\
+    \
+    -print0)
+
+
+readarray -d '' tmp < <(find . "${excludes[@]}" -type f ! -name '*.*' -perm /111  -print0)
+for file in "${tmp[@]}"; do
+    head -n1 "$file" | grep -Eqs "^#! */[^ ]*/[abkz]*sh" || continue
+    filepaths+=("$file")
+done
+
+if  find . "${excludes[@]}" -path '*bin/*/*' -type f -perm /111 -print |
+    grep .
+then
+    echo >&2 "::warning:: subdirectories of bin directories are not usable via PATH"
+fi
+
+if  find . "${excludes[@]}" -path '*bin/*' -name '*.*' -type f -perm /111 -perm /444 -print |
+    grep .
+then
+    echo >&2 "::warning:: programs in PATH should not have a filename suffix"
+fi
+
+for file in "${filepaths[@]}"; do
+    echo "::debug:: Checking $file"
+    shellcheck "$file" || statuscode=$?
+done
+
+exit "$statuscode"

testfiles/ignore/ignore.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+echo $test

testfiles/test

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

testfiles/test.bash

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

testfiles/test.sh

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