Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Request: Automated releases, Repo Hygiene #34

Open
korenyoni opened this issue Nov 21, 2022 · 2 comments · May be fixed by #95
Open

Request: Automated releases, Repo Hygiene #34

korenyoni opened this issue Nov 21, 2022 · 2 comments · May be fixed by #95
Assignees
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@korenyoni
Copy link
Contributor

korenyoni commented Nov 21, 2022

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:

Here are examples of popular Terraform module repos using what I've described above:

I can easily add some of these in (as so can another volunteer), but wondering what your thoughts are.

@bwhaley
Copy link
Member

bwhaley commented Nov 21, 2022

Great suggestion! This is on my todo list.

@bwhaley bwhaley added good first issue Good for newcomers help wanted Extra attention is needed labels Nov 21, 2022
@madhurimachime madhurimachime self-assigned this Nov 21, 2022
@inga inga linked a pull request May 10, 2024 that will close this issue
@nitrocode
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants