Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peterdavehello/docker-yamllint
🐳 Dockerized yamllint with proper versioning, a linter for YAML files.
https://github.com/peterdavehello/docker-yamllint
ci container continuous-integration docker docker-image hacktoberfest image lint linter yaml yamllint
Last synced: 11 days ago
JSON representation
🐳 Dockerized yamllint with proper versioning, a linter for YAML files.
- Host: GitHub
- URL: https://github.com/peterdavehello/docker-yamllint
- Owner: PeterDaveHello
- Created: 2019-07-22T16:02:02.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-03T05:49:46.000Z (4 months ago)
- Last Synced: 2024-10-19T23:24:10.730Z (19 days ago)
- Topics: ci, container, continuous-integration, docker, docker-image, hacktoberfest, image, lint, linter, yaml, yamllint
- Language: Shell
- Homepage: https://hub.docker.com/r/peterdavehello/yamllint/
- Size: 15.6 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# docker-yamllint
[](https://app.travis-ci.com/PeterDaveHello/docker-yamllint)
[](https://hub.docker.com/r/peterdavehello/yamllint/)
[](https://hub.docker.com/r/peterdavehello/yamllint/)
Dockerized [yamllint](https://github.com/adrienverge/yamllint) with various versions, easy to use and easy to integrate with CI.
## Table of Contents
- [Usage](#usage)
- [Command line](#command-line)
- [Use latest version](#use-latest-version)
- [Use specific version](#use-specific-version)
- [Continuous Integration (CI)](#continuous-integration-ci)
- [Travis CI](#travis-ci)
- [GitLab CI](#gitlab-ci)
- [Build](#build)
## Usage
### Command line
#### Use latest version
```sh
docker run --rm -v $PATH_TO_YAML:/yaml peterdavehello/yamllint yamllint YAML_FILE.yml
# Please replace "$PATH_TO_YAML" with your custom path,
# and replace "YAML_FILE.yml" with your real yaml file filename.
```
#### Use specific version
Just like above, but you can specify version of yamllint, for example:
```sh
docker run --rm -v $PATH_TO_YAML:/yaml peterdavehello/yamllint:1.16.0 yamllint YAML_FILE.yml
# Please replace "1.16.0" with the version number you want.
# Don't forget to replace "$PATH_TO_YAML" & "YAML_FILE.yml".
```
### Continuous Integration (CI)
#### Travis CI
Enable Docker service in your `.travis.yml`:
```yaml
services:
- docker
```
And use the same command in the `scripts` part as the command line mentions, for example:
```yaml
services:
- docker
scripts:
- docker run --rm -v $TRAVIS_BUILD_DIR:/yaml peterdavehello/yamllint:1.16.0 yamllint .travis.yml
```
This will lint the Travis CI config file `.travis.yml`
#### GitLab CI
Add this block to your `.gitlab-ci.yml`:
```yaml
yamllint:
stage: lint
variables:
yamllint_version: "1.16.0"
image: peterdavehello/yamllint:$yamllint_version
only:
changes:
- "**/*.yml"
- "**/*.yaml"
script:
- find . -name "*.yml" -o -name "*.yaml" | xargs -n 1 yamllint
```
Replace "1.16.0" with the version you want to use, you can also use "latest" for the very new version.
## Build
Build command, you need to specify a valid yamllint version argument to `YAMLLINT_VERSION`:
```sh
docker build --build-arg YAMLLINT_VERSION="1.16.0" -t docker-yamllint .
# Replace "docker-yamllint" with the preferred image name
```
You can find a valid version in the [release history](https://pypi.org/project/yamllint/#history) on PyPI, or just poke the [API](https://pypi.org/pypi/yamllint/json) to retrieve more details.