From ed7469caaf82f873f82867e73aa179063f5ac23f Mon Sep 17 00:00:00 2001 From: Antoine Eiche Date: Fri, 30 Sep 2022 16:22:19 +0200 Subject: [PATCH] readme: how to generate the doc and how to release --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index baa3291c..1f4dd77c 100644 --- a/README.md +++ b/README.md @@ -169,6 +169,21 @@ we use the [tfplugindocs](https://github.com/hashicorp/terraform-plugin-docs) project to generate the provider documentation. +To generate the documentation, just run: + + $ tfplugindocs + +### Releasing + +There are GitHub actions configured to generate a release from a tag +such as described in the [Terraform provider +documentation](https://learn.hashicorp.com/tutorials/terraform/provider-release-publish?in=terraform/providers) + +To publish a new release: + + $ git tag vX.X + $ git push origin vX.X + ## Adding Dependencies This provider uses [Go modules](https://github.com/golang/go/wiki/Modules).