drone-pre-commit/Readme.md
Ian Fijolek 93e6f791b8
All checks were successful
continuous-integration/drone/push Build is passing
Update readme with new included dependencies
2021-02-05 12:30:14 -08:00

36 lines
917 B
Markdown

# drone-pre-commit
A [pre-commit](https://pre-commit.com) plugin, for the drone.io project, which allows you to run pre-commit checks as part of your build steps.
## Examples
An example configuration would be as follows:
```yaml
steps:
- name: run checks
image: iamthefij/drone-pre-commit:latest
```
Or, if you have additional dependencies to install
```yaml
steps:
- name: run ruby dependent checks
image: iamthefij/drone-pre-commit:latest
commands:
- apt-get update
- apt-get install -y --no-install-recommends ruby
# You must run your own pre-commit command at the end
- pre-commit run --all-files
```
## Personal image
A second image is also built for my personal use, but it may be useful to you as well. This image includes the following dependencies:
* hadolint
* golang
* golangci-lint
Installation scripts referencing versions are found in `./scripts`.