yamllint Docker image

This repository provides a lightweight alpine-based Docker image for yamllint.

Supported tags and respective Dockerfile links

1.26.3, 1.26, 1, latest

Usage

Command line

To lint the yaml files in the current directory, run the following command:

docker run -it --rm -v "$(pwd):/workdir" ghcr.io/ffurrer2/yamllint:latest .

GitHub Actions

To use yamllint within GitHub Actions, add the following job to your workflow file:

yamllint:
  runs-on: ubuntu-latest
  steps:
    - name: Checkout
      uses: actions/checkout@v3
    - name: yamllint
      uses: docker://ghcr.io/ffurrer2/yamllint:latest
      with:
        args: '--format github .'

Examples

Lint a single yaml file

docker run -it --rm -v "$(pwd):/workdir" ghcr.io/ffurrer2/yamllint my-file.yaml

Lint all yaml files in a subdirectory

docker run -it --rm -v "$(pwd):/workdir" ghcr.io/ffurrer2/yamllint ./subdir

Use `yamllint` options

docker run -it --rm -v "$(pwd):/workdir" ghcr.io/ffurrer2/yamllint --strict --format parsable .

Show help message

docker run -it --rm ghcr.io/ffurrer2/yamllint

Show version

docker run -it --rm ghcr.io/ffurrer2/yamllint --version

License

This project is licensed under the MIT License.

View license information for Python 3 and yamllint.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

Some additional license information which was able to be auto-detected might be found in the repo-info repository's alpine/ directory.

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.

ffurrer2/docker-yamllint