action-validator 使用教程

action-validator 使用教程

action-validatorTool to validate GitHub Action and Workflow YAML files项目地址:https://gitcode.com/gh_mirrors/ac/action-validator

项目介绍

action-validator 是一个用于验证 GitHub Action 和 Workflow YAML 文件的工具。它可以帮助开发者在提交代码前检查 YAML 文件的格式和内容是否符合规范，从而避免因配置错误导致的 CI/CD 流程失败。该项目是开源的，遵循 GPL-3.0-only 许可证。

项目快速启动

安装

你可以通过 Homebrew 安装 action-validator：

brew install action-validator

或者通过 NPM 安装：

npm install -g @action-validator/core @action-validator/cli --save-dev

使用

安装完成后，你可以通过以下命令验证 YAML 文件：

action-validator <path_to_action_yaml>

例如：

action-validator .github/workflows/build.yml

应用案例和最佳实践

在 pre-commit 钩子中使用

为了确保每次提交的 YAML 文件都是有效的，你可以在 pre-commit 钩子中使用 action-validator：

repos:
  - repo: local
    hooks:
      - id: action-validator
        name: action-validator
        entry: action-validator
        language: system
        types: [yaml]

在 GitHub Action 中使用

你也可以在 GitHub Action 中使用 action-validator 作为 PR 检查的一部分：

jobs:
  validate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Set up action-validator
        run: brew install action-validator
      - name: Validate YAML files
        run: action-validator .github/workflows/build.yml

典型生态项目

SchemaStore

action-validator 使用了 SchemaStore 作为 YAML 文件的验证标准。SchemaStore 是一个社区驱动的 JSON Schema 存储库，提供了大量的 JSON 和 YAML 文件验证模式。

asdf

action-validator 也可以通过 asdf 进行安装和管理：

asdf plugin add action-validator
asdf install action-validator latest
asdf global action-validator latest

通过 asdf，你可以方便地管理多个版本的 action-validator，并确保在不同的项目中使用正确的版本。

---

通过以上教程，你应该能够快速上手并使用 action-validator 来验证你的 GitHub Action 和 Workflow YAML 文件。希望这个工具能帮助你提高 CI/CD 流程的稳定性和效率。

action-validatorTool to validate GitHub Action and Workflow YAML files项目地址:https://gitcode.com/gh_mirrors/ac/action-validator