shell linter

Taller

Una acción de GitHub que realiza un análisis estático para scripts de shell usando shellcheck.

Uso

El enlace de concha puede realizar un análisis estático de varias maneras. De forma predeterminada, escanea todos los scripts de shell compatidos con shellcheck (sh/bash/dash/ksh) en su proyecto. Sin embargo, puede usar el parámetro path para escanear un archivo o carpeta específica o usar el parámetro exclude-paths para excluir archivos o carpetas del escaneo. Con el enlace de shell, también puede especificar la gravedad mínima de los errores a considerar usar el parámetro severity . Los casos de uso específicos junto con ejemplos se muestran a continuación:

Ejecute el análisis estático para todos los scripts de shell compatibles en su repositorio:

 jobs :
  lint :
    runs-on : ubuntu-latest
    steps :
      - name : Checkout code
        uses : actions/checkout@v1
      - name : Run ShellCheck
        uses : azohra/shell-linter@latest 

Ejecute el análisis estático para un solo script de shell:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " setup.sh " 

Ejecute el análisis estático para múltiples scripts de shell con o sin extensión:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " setup,deploy.sh " 

Ejecute el análisis estático para todos los scripts de shell en una carpeta:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " src " 

Ejecute el análisis estático utilizando una ruta comodín :

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " src/*.sh " 

Excluir archivos y carpetas del análisis estático:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          exclude-paths : " src/setup.sh,tests/unit_tests " 

Tenga en cuenta que exclude-paths solo acepta rutas en relación con el directorio raíz de su proyecto. Sin embargo, no incluya ./ al comienzo de los caminos.

Para excluir una carpeta y su contenido recursivamente, solo proporcione la ruta de la carpeta sin A / al final. En el ejemplo anterior, la carpeta completa en las tests/unit_tests se excluirá de la pelusa.

Ejecute el análisis estático para todos los scripts de shell y solo informe el problema con la gravedad del error:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " src/*.sh "
          severity : " error " 

Ejecute el análisis utilizando una versión específica de Shell Linter:

      - name : Run ShellCheck
        uses : azohra/[email protected]

Aporte

path

Opcional. Ejecute la verificación de la pelusa en un archivo o carpeta específica. Por defecto: .

exclude-paths

Opcional. Excluya archivos y carpetas de shellcheck scan.

severity

Opcional. Especifique la gravedad mínima de los errores para considerar [estilo, información, advertencia, error]. Valor predeterminado: style

Licencia

Este software está disponible como código abierto bajo los términos de la licencia MIT.