Request: Automated releases, Repo Hygiene
korenyoni opened this issue · 2 comments
This is not a feature request in the technical sense, but having to do with the GitHub repo itself.
This project is clearly picking up since its inception, but the GitHub repo itself is missing a few things relating to GitHub repo best practices and release automation. The biggest thing is that the Terraform module is in v0.1.0, and the code works, which is great. But what happens when someone makes a pull request for a hotfix or a new feature? Cutting releases manually is generally prone to human error and leads to arbitrary semantic version bumps. So I propose a few things in this repo that can make it easier to manage in the long term:
- Manage semantic versions and GitHub releases automatically based on pull requests and labels using release-drafter.
- Templates for feature requests and bug reports.
Here are examples of popular Terraform module repos using what I've described above:
- https://github.com/cloudposse/terraform-aws-eks-cluster
- https://github.com/terraform-aws-modules/terraform-aws-eks (not using release-drafter but a GHA equivalent in nature).
I can easily add some of these in (as so can another volunteer), but wondering what your thoughts are.
Great suggestion! This is on my todo list.
For hygiene, some additional items
- terraform-docs output added to readme
- pre-commit hooks to run terraform-docs and other hooks
Thank you for considering