irasnyd/puppet-lint-action

Puppet Lint的GitHub Action

该Action用于Puppet Lint，支持与Puppet Lint进行任意交互，以测试Puppet代码是否符合推荐的Puppet语言风格指南。

Puppet Lint仅验证代码风格，不验证语法。如果需要执行语法验证，可以使用https://github.com/irasnyd/puppet-parser-validate-action/ GitHub Action。

使用方法

以下是测试清单是否符合Puppet风格的工作流示例——使用puppet-lint命令，并将想要测试的文件路径作为args参数。

yaml
name: Puppet Lint

on: [push]

jobs:
  puppet-lint:

    runs-on: ubuntu-latest

    steps:
    - name: Checkout
      uses: actions/checkout@v2

    - name: puppet-lint
      uses: irasnyd/puppet-lint-action@master
      with:
        args: ./

如果希望使用特定版本，且无需每次重建容器，可以使用https://hub.docker.com/r/irasnyd/puppet-parser-validate-action%E4%B8%8A%E6%89%98%E7%AE%A1%E7%9A%84%E7%89%88%E6%9C%AC%E3%80%82

yaml
name: Puppet Lint

on: [push]

jobs:
  puppet-lint:

    runs-on: ubuntu-latest

    steps:
    - name: Checkout
      uses: actions/checkout@v2

    - name: puppet-lint
      uses: docker://irasnyd/puppet-lint-action:2.4.2-2
      with:
        args: ./

更多使用细节请参见https://github.com/rodjek/puppet-lint#testing-with-puppet-lint%E3%80%82

完整示例

yaml
name: Puppet Lint

on: [push]

jobs:
  puppet-lint:

    runs-on: ubuntu-18.04

    steps:

    # 从GitHub仓库检出源代码
    - name: Checkout Source Code
      uses: actions/checkout@v2
      with:
        fetch-depth: 0

    # 确定此Pull Request中提交的更改文件
    # https://github.com/trilom/file-changes-action
    # https://github.com/marketplace/actions/file-changes-action
    - name: Get Changed Files
      id: get_file_changes
      uses: trilom/file-changes-action@v1.2.3

    # 从新增/修改的文件中筛选出Puppet清单(*.pp)
    # 将Puppet清单文件名存储到名为files的输出中
    # 将Puppet清单数量存储到名为numfiles的输出中
    - name: Filter Puppet Manifests
      id: puppet_manifests
      run: |
        jq '.[] | select(.|endswith(".pp"))' $HOME/files_added.json $HOME/files_modified.json > $HOME/manifests.txt
        echo "::set-output name=files::$(cat $HOME/manifests.txt | tr '\n' ' ')"
        echo "::set-output name=numfiles::$(cat $HOME/manifests.txt | wc -l)"

    # 对新增/修改的Puppet清单运行Puppet Lint
    - name: Puppet Lint
      uses: docker://irasnyd/puppet-lint-action:2.4.2-2
      with:
        args: --no-140chars-check --no-class_inherits_from_params_class-check --no-relative_classname_inclusion-check ${{ steps.puppet_manifests.outputs.files }}
      if: "steps.puppet_manifests.outputs.numfiles > 0"

许可证

本项目中的Dockerfile及相关脚本和文档以MIT许可证发布。

使用本项目构建的容器镜像包含第三方材料。详情参见THIRD_PARTY_NOTICE.md。