botsudo/action-shellcheck

ShellCheck GitHub Action 镜像文档

镜像概述

本镜像为GitHub Action，用于在GitHub Actions工作流中运行ShellCheck工具，对shell脚本进行静态分析，检查语法错误、潜在问题和最佳实践合规性。基于koalaman/shellcheck基础镜像构建，并包含make和bash工具，方便在CI/CD流程中集成shell脚本检查。

镜像可在https://hub.docker.com/r/botsudo/action-shellcheck%E8%8E%B7%E5%8F%96%EF%BC%8CDocker%E6%8B%89%E5%8F%96%E9%87%8F%E5%BE%BD%E7%AB%A0%EF%BC%9A!%5BDocker Pulls](https://hub.docker.com/r/botsudo/action-shellcheck)

核心功能与特性

• 基于官方ShellCheck：使用koalaman/shellcheck作为基础镜像，确保ShellCheck功能的完整性和权威性
• 工具集成：内置make和bash，满足复杂构建和脚本执行需求
• 灵活配置：支持通过cli-args参数传递ShellCheck的所有命令行选项
• GitHub Actions原生支持：专为GitHub Actions设计，可直接在工作流文件中配置使用

使用场景

• GitHub仓库中shell脚本的自动化静态分析
• CI/CD流程中集成shell脚本质量检查，提前发现潜在问题
• 开源项目或团队协作中规范shell脚本编写标准

使用方法与配置说明

基本使用示例

在GitHub Actions工作流文件（如.github/workflows/shellcheck.yml）中添加以下步骤：

yaml
  - uses: actions/checkout@v4  # 检出代码仓库
  - name: 运行ShellCheck
    uses: sudo-bot/action-shellcheck@latest
    with:
        # 传递ShellCheck命令行参数，具体可参考https://github.com/koalaman/shellcheck#how-to-use
        cli-args: "myscript.sh"  # 检查指定的shell脚本文件

高级使用示例

通过cli-args参数传递更多ShellCheck选项，如指定输出格式、设置严重级别等：

yaml
  - uses: actions/checkout@v4
  - name: 运行ShellCheck（高级配置）
    uses: sudo-bot/action-shellcheck@latest
    with:
        # 示例：以checkstyle格式输出，仅显示info及以上级别的问题
        cli-args: "--format=checkstyle --severity=info script.sh"

参数说明