https://github.com/leplusorg/docker-yaml
Docker container with utilities to process YAML files (yamllint...).
https://github.com/leplusorg/docker-yaml
docker docker-container docker-image dockerfile yaml yaml-parser yaml-processor yaml-to-json yaml-validator yaml2json yamllint yamlpath yq
Last synced: about 2 months ago
JSON representation
Docker container with utilities to process YAML files (yamllint...).
- Host: GitHub
- URL: https://github.com/leplusorg/docker-yaml
- Owner: leplusorg
- License: apache-2.0
- Created: 2019-12-03T23:13:42.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-05-23T03:00:53.000Z (about 1 year ago)
- Last Synced: 2024-05-23T03:33:43.403Z (about 1 year ago)
- Topics: docker, docker-container, docker-image, dockerfile, yaml, yaml-parser, yaml-processor, yaml-to-json, yaml-validator, yaml2json, yamllint, yamlpath, yq
- Language: Dockerfile
- Homepage: https://hub.docker.com/r/leplusorg/yaml
- Size: 209 KB
- Stars: 6
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# YAML
Docker container with utilities to process YAML files (yamllint...).
[](yaml/Dockerfile)
[](https://github.com/leplusorg/docker-yaml/actions?query=workflow:"Docker")
[](https://hub.docker.com/r/leplusorg/yaml)
[](https://hub.docker.com/r/leplusorg/yaml)
[](https://hub.docker.com/r/leplusorg/yaml)
[](https://bestpractices.coreinfrastructure.org/projects/10074)
[](https://securityscorecards.dev/viewer/?uri=github.com/leplusorg/docker-yaml)
## Example not using the filesystem
Let's say that you have a file `foo.yml` in your current working directory that you want to validate:
**Mac/Linux**
```bash
cat foo.yml | docker run --rm -i --net=none leplusorg/yaml yamllint -
```
**Windows**
```batch
type foo.yml | docker run --rm -i --net=none leplusorg/yaml yamllint -
```
## Example using the filesystem
Same thing, assuming that you have a file `foo.yml` in your current working directory that you want to validate:
**Mac/Linux**
```bash
docker run --rm -t --user="$(id -u):$(id -g)" --net=none -v "$(pwd):/tmp" leplusorg/yaml yamllint /tmp/foo.yml
```
**Windows**
In `cmd`:
```batch
docker run --rm -t --net=none -v "%cd%:/tmp" leplusorg/yaml yamllint /tmp/foo.yml
```
In PowerShell:
```pwsh
docker run --rm -t --net=none -v "${PWD}:/tmp" leplusorg/yaml yamllint /tmp/foo.yml
```
## Help
To know more command-line options of `yamllint`:
```bash
docker run --rm --net=none leplusorg/yaml yamllint -h
```
## Software Bill of Materials (SBOM)
To get the SBOM for the latest image (in SPDX JSON format), use the
following command:
```bash
docker buildx imagetools inspect leplusorg/yaml --format '{{ json (index .SBOM "linux/amd64").SPDX }}'
```
Replace `linux/amd64` by the desired platform (`linux/amd64`, `linux/arm64` etc.).
### Sigstore
[Sigstore](https://docs.sigstore.dev) is trying to improve supply
chain security by allowing you to verify the origin of an
artifcat. You can verify that the jar that you use was actually
produced by this repository. This means that if you verify the
signature of the ristretto jar, you can trust the integrity of the
whole supply chain from code source, to CI/CD build, to distribution
on Maven Central or whever you got the jar from.
You can use the following command to verify the latest image using its
sigstore signature attestation:
```bash
cosign verify leplusorg/yaml --certificate-identity-regexp 'https://github\.com/leplusorg/docker-yaml/\.github/workflows/.+' --certificate-oidc-issuer 'https://token.actions.githubusercontent.com'
```
The output should look something like this:
```text
Verification for index.docker.io/leplusorg/xml:main --
The following checks were performed on each of these signatures:
- The cosign claims were validated
- Existence of the claims in the transparency log was verified offline
- The code-signing certificate was verified using trusted certificate authority certificates
[{"critical":...
```
For instructions on how to install `cosign`, please read this [documentation](https://docs.sigstore.dev/cosign/system_config/installation/).
## Request new tool
Please use [this link](https://github.com/leplusorg/docker-yaml/issues/new?assignees=thomasleplus&labels=enhancement&template=feature_request.md&title=%5BFEAT%5D) (GitHub account required) to request that a new tool be added to the image. I am always interested in adding new capabilities to these images.