actionlint-py 1.6.25.2

Python wrapper around invoking actionlint (https://github.com/rhysd/actionlint)

actionlint-py

A python wrapper to provide a pip-installable actionlint binary.

Internally this package provides a convenient way to download the pre-built actionlint binary for your particular platform.

Installation

pip install actionlint-py

Usage

After installation, the actionlint binary should be available in your environment (or actionlint.exe on windows).

As a pre-commit hook

See pre-commit for instructions

Sample .pre-commit-config.yaml:

- repo: https://github.com/Mateusz-Grzelinski/actionlint-py
  rev: v1.6.25
  hooks:
    - id: actionlint

or to avoid going twice to internet (might help with proxy):

- repo: local
  hooks:
    - id: actionlint
      name: actionlint
      description: Test yaml scripts with actionlint
      #      additional_dependencies: [actionlint-py==1.6.22.2] # safer, but pre-commit autoupdate will not work
      additional_dependencies: [ actionlint-py ]
      entry: actionlint
      #      args: [-ignore "*.set-output. was depracated.*"]
      language: python
      types: [ "yaml" ]
      files: "^.github/workflows/"

Development

Development of wrapper and releasing new version: see README-DEV.md