action-sh-checker 使用教程

1. 项目介绍

action-sh-checker 是一个 GitHub Action，用于对 Shell 脚本进行静态分析。它集成了 shellcheck、shfmt 和 checkbashisms 工具，帮助开发者自动检查和格式化 Shell 脚本，确保代码质量和一致性。

主要功能

• ShellCheck: 用于检查 Shell 脚本中的常见错误和潜在问题。
• shfmt: 用于格式化 Shell 脚本，确保代码风格一致。
• checkbashisms: 用于检查 Shell 脚本中是否存在 Bash 特有的语法，避免在其他 Shell 环境中运行时出现问题。

2. 项目快速启动

2.1 安装

无需额外安装，只需在 GitHub 仓库的 .github/workflows 目录下创建一个新的工作流文件，例如 sh-checker.yml。

2.2 配置

在工作流文件中添加以下内容：

name: Shell Script Checker

on:
  - pull_request

jobs:
  sh-checker:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Run the sh-checker
        uses: luizm/action-sh-checker@master
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          sh_checker_comment: true
          sh_checker_exclude: "terraform ^dir/example.sh"

2.3 运行

提交并推送该工作流文件到 GitHub 仓库后，每当有新的 Pull Request 时，action-sh-checker 将自动运行，检查 Shell 脚本并生成报告。

3. 应用案例和最佳实践

3.1 应用案例

• CI/CD 自动化: 在 CI/CD 流水线中集成 action-sh-checker，确保每次提交的 Shell 脚本都符合最佳实践和代码规范。
• 代码审查: 在 Pull Request 中自动生成 Shell 脚本的检查报告，帮助代码审查者快速发现潜在问题。

3.2 最佳实践

• 排除特定目录或文件: 使用 sh_checker_exclude 参数排除不需要检查的目录或文件，例如第三方库或配置文件。
• 自定义检查选项: 通过 SHELLCHECK_OPTS 和 SHFMT_OPTS 环境变量自定义 shellcheck 和 shfmt 的检查选项，满足特定项目的需求。

4. 典型生态项目

• ShellCheck: 一个用于检查 Shell 脚本错误的工具，action-sh-checker 集成了该工具。
• shfmt: 一个用于格式化 Shell 脚本的工具，action-sh-checker 也集成了该工具。
• checkbashisms: 一个用于检查 Shell 脚本中是否存在 Bash 特有语法的工具，action-sh-checker 同样集成了该工具。

通过这些工具的集成，action-sh-checker 提供了一个全面的 Shell 脚本静态分析解决方案。