mirror of
https://github.com/thegeeklab/drone-yaml.git
synced 2024-11-24 11:00:39 +00:00
60 lines
1.8 KiB
Markdown
60 lines
1.8 KiB
Markdown
---
|
|
title: drone-yaml
|
|
---
|
|
|
|
[](https://drone.thegeeklab.de/thegeeklab/drone-yaml)
|
|
[](https://hub.docker.com/r/thegeeklab/drone-yaml)
|
|
[](https://quay.io/repository/thegeeklab/drone-yaml)
|
|
[](https://github.com/thegeeklab/drone-yaml/graphs/contributors)
|
|
[](https://github.com/thegeeklab/drone-yaml)
|
|
[](https://github.com/thegeeklab/drone-yaml/blob/main/LICENSE)
|
|
|
|
Custom linter and formatter for the [Drone](https://github.com/drone/drone) YAML configuration file format.
|
|
|
|
<!-- prettier-ignore-start -->
|
|
<!-- spellchecker-disable -->
|
|
{{< toc >}}
|
|
<!-- spellchecker-enable -->
|
|
<!-- prettier-ignore-end -->
|
|
|
|
## Build
|
|
|
|
Build the binary with the following command:
|
|
|
|
```Shell
|
|
export GOOS=linux
|
|
export GOARCH=amd64
|
|
export CGO_ENABLED=0
|
|
export GO111MODULE=on
|
|
|
|
make build
|
|
```
|
|
|
|
Build the Docker image with the following command:
|
|
|
|
```Shell
|
|
docker build --file docker/Dockerfile.amd64 --tag thegeeklab/drone-yaml .
|
|
```
|
|
|
|
## Usage
|
|
|
|
{{< hint type=important >}}
|
|
Be aware that the tool only supports configuration files for the Drone Docker runner!
|
|
{{< /hint >}}
|
|
|
|
Lint the YAML file:
|
|
|
|
```Shell
|
|
drone-yaml lint samples/simple.yml
|
|
```
|
|
|
|
Format the YAML file:
|
|
|
|
```Shell
|
|
# default is printing to stdout
|
|
drone-yaml fmt samples/simple.yml
|
|
|
|
# optionally update the formatted file in place
|
|
drone-yaml fmt samples/simple.yml --save
|
|
```
|