mirror of
https://github.com/Kichiyaki/terraform-provider-woodpecker.git
synced 2024-07-01 08:38:06 +00:00
feat: add README.md
This commit is contained in:
parent
f1fd4d5961
commit
5d46f038f6
29
README.md
Normal file
29
README.md
Normal file
|
@ -0,0 +1,29 @@
|
||||||
|
# Terraform Provider for Woodpecker CI
|
||||||
|
|
||||||
|
A Terraform provider used to interact with [Woodpecker CI](https://woodpecker-ci.org/) resources.
|
||||||
|
|
||||||
|
## Developing the provider
|
||||||
|
|
||||||
|
**Requirements:**
|
||||||
|
|
||||||
|
- [Terraform](https://developer.hashicorp.com/terraform/downloads) >= 1.0
|
||||||
|
- [Go](https://golang.org/doc/install) >= 1.21
|
||||||
|
- [Docker](https://docs.docker.com/engine/install/) (for tests)
|
||||||
|
- [pre-commit](https://pre-commit.com/) (optional, but recommended)
|
||||||
|
- [Node.js](https://nodejs.org/en) (LTS, only needed for commitlint)
|
||||||
|
- [direnv](https://direnv.net/) (optional, but recommended)
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# if you have direnv installed
|
||||||
|
direnv allow
|
||||||
|
|
||||||
|
# install git hooks and required tools (terraform-plugin-docs, golangci-lint)
|
||||||
|
make install
|
||||||
|
|
||||||
|
# run tests
|
||||||
|
go test ./...
|
||||||
|
```
|
||||||
|
|
||||||
|
## Contact
|
||||||
|
|
||||||
|
Dawid Wysokiński - [contact@dwysokinski.me](mailto:contact@dwysokinski.me)
|
Loading…
Reference in New Issue
Block a user