From 5d46f038f6f414b7678b241984563ebcdbdf5434 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dawid=20Wysoki=C5=84ski?= Date: Thu, 7 Sep 2023 08:03:53 +0200 Subject: [PATCH] feat: add README.md --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..2138359 --- /dev/null +++ b/README.md @@ -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)