Skip to content

Conversation

@yottta
Copy link
Contributor

@yottta yottta commented Nov 18, 2025

This PR tries to make clearer what scripts in this repo are for and how should be used together with the workflows.

The main points that I wanted to tackle (and it's up to the reviewer to say if it's enough or not) are as follows:

  • Create a readme/good doc for each script that we have to make it clearer about its scope and what it can do. This, hopefully, will help in the future to make use of those in other more interesting and useful ways.
  • Unify as much as possible (especially the sh scripts) for errors, usage, general parsing and so, to be easier to go through and make it easier for any user of that to understand how to use it and for which it should/can be used.
  • Update the root README.md with some clearer use cases, and more in-depth information on how the scripts should be used together, what should be the order in case of different use cases, etc.

Signed-off-by: Andrei Ciobanu <andrei.ciobanu@opentofu.org>
@yottta yottta force-pushed the rework-documentation branch from 96a50f6 to f0a478e Compare November 19, 2025 09:20
Signed-off-by: Andrei Ciobanu <andrei.ciobanu@opentofu.org>
Signed-off-by: Andrei Ciobanu <andrei.ciobanu@opentofu.org>
@yottta yottta force-pushed the rework-documentation branch from 313f118 to a35506a Compare November 19, 2025 13:02
Signed-off-by: Andrei Ciobanu <andrei.ciobanu@opentofu.org>
Signed-off-by: Andrei Ciobanu <andrei.ciobanu@opentofu.org>
Signed-off-by: Andrei Ciobanu <andrei.ciobanu@opentofu.org>
Signed-off-by: Andrei Ciobanu <andrei.ciobanu@opentofu.org>
Signed-off-by: Andrei Ciobanu <andrei.ciobanu@opentofu.org>
@yottta yottta force-pushed the rework-documentation branch from 49e4510 to 77d6e92 Compare November 19, 2025 13:59
Signed-off-by: Andrei Ciobanu <andrei.ciobanu@opentofu.org>
Even though GH redirects to the correct repository when cloning from the
opentffoundation, that is clearly wrong and confusing.
Replacing the old name of "opentffoundation" with "opentofu"

Signed-off-by: Andrei Ciobanu <andrei.ciobanu@opentofu.org>
@yottta yottta force-pushed the rework-documentation branch from a12b8c8 to e8d0520 Compare November 19, 2025 14:08
Signed-off-by: Andrei Ciobanu <andrei.ciobanu@opentofu.org>
Signed-off-by: Andrei Ciobanu <andrei.ciobanu@opentofu.org>
Copy link
Contributor Author

@yottta yottta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some comments for some things that I wanted to point out in case somebody have something against or something to add.

In addition to that, please comment (or just update this branch with your own commits) with other information that you consider valuable for future usage of these scripts:

  • what GPG keys are stored where? How those are generated for scripts vs terraform-provider-* repos (do all the repos have the same key? or any one of those have a different key?)
  • do we have any terraform-provider-* repositories that shouldn't be managed by these scripts? (ie: lua?) If yes, why?

### [`gpg.yml`](./.github/workflows/gpg.yml)
This can generate new GPG keys for the provider repositories to use those for signing new releases.
> [!WARNING]
> From the looks of it, in the [gpg script](./go/gpg/main.go), the lifespan of such keys is hardcoded to 3 years.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If somebody can offer more context here on how the renewal of this should be handled, would be great to have it for the future.

@yottta yottta marked this pull request as ready for review November 19, 2025 16:57
Copy link

@lbordowitz lbordowitz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the READMEs made sense and gave me a good handle on how to run them and why.

Copy link
Member

@Gogotchuri Gogotchuri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this work!
Made a lot simpler to understand what each part of this repository does.

Copy link
Member

@diofeher diofeher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great stuff!

@yottta yottta force-pushed the rework-documentation branch from b91b6d6 to 9cda7ac Compare December 22, 2025 13:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants