Contributions are welcome via GitHub pull requests. This document outlines the process to help get your contribution accepted.
- Fork this repository, develop, and test your changes.
- Submit a pull request.
-
All changes require a version bump following semver principles. See Immutability and Versioning below.
-
All resources and data sources must be documented. See Documentation below.
Once the changes have been merged, a release job will automatically run to package and release the changes with a new version.
Version releases must be immutable. Any change warrants a version bump even if there are only documentation changes.
Documentaion is being automatically generated by tfplugindocs. Please go over the Readme file first and follow the procedure:
-
Add a "Description" attribute for each data-source/resource(Resource-Level and Field-Level descriptions). See this secret example.
-
Create a Terraform example file inside the examples/ folder. Please make sure that the resource.tf/data-source.tf follows the folder structure and naming convention: examples/{resources/data-sources}/{resource name/data-source name}/{resource.tf/data-source.tf}, for example: examples/resources/akeyless_secret/resource.tf
-
Run tfplugindocs command from the repository root folder:
go generate- Check the newly generated documentation inside the docs/ folder, and commit it to your pull request.
The Release version should follow semver.
Bump the version by editing the version file. The version number will be reviewed in the pull request.