Skip to content

Commit

Permalink
readme: how to generate the doc and how to release
Browse files Browse the repository at this point in the history
  • Loading branch information
nlewo committed Sep 30, 2022
1 parent 35fa70a commit ed7469c
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down

0 comments on commit ed7469c

Please sign in to comment.