Skip to content

Update protoc-gen-terraform to v3.0.0#47374

Merged
eriktate merged 3 commits intomasterfrom
eriktate/update-terraform-custom-types
Oct 10, 2024
Merged

Update protoc-gen-terraform to v3.0.0#47374
eriktate merged 3 commits intomasterfrom
eriktate/update-terraform-custom-types

Conversation

@eriktate
Copy link
Copy Markdown
Contributor

@eriktate eriktate commented Oct 8, 2024

Relates to #33288

This PR makes some necessary changes to update protoc-gen-terraform to v3.0.0. It's a large PR because it also adds a bunch of terraform provider reference documentation that was failing to generate before. For that reason, this is split into two commits. The first one contains the actual code/configuration changes required to move to v3.0.0. The second contains only the generated documentation changes. I don't think I can actually split this into multiple PRs due to the linter requiring terraform generation to run, but if there's a good way to make this smaller I'm happy to do that 👍

changelog: Added missing field-level documentation to the terraform provider reference.

configs to support using protoc-gen-terraform v3.0.0
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 8, 2024

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 8, 2024

🤖 Vercel preview here: https://docs-1bjssv8pq-goteleport.vercel.app/docs/ver/preview

Copy link
Copy Markdown
Contributor

@hugoShaka hugoShaka left a comment

Choose a reason for hiding this comment

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

LGTM and thank you so much for improving the provider and its documentation.

The prose linter is failing but you can ignore it. Don't rewrite every proto message.

The Go Linter is failing because it cannot install the correct version. Would you mind updating the protoc-gen-tfschema ref in the CI job? Edoardo pinned it in #47268.

@tigrato
Copy link
Copy Markdown
Contributor

tigrato commented Oct 9, 2024

@eriktate you also need to update the lint workflow and integrations/terraform/Makefile to use v3.0.0

check https://github.com/gravitational/teleport/pull/47269/files

@eriktate eriktate force-pushed the eriktate/update-terraform-custom-types branch from 50e4794 to 65dfba5 Compare October 9, 2024 17:52
@eriktate eriktate requested a review from klizhentas as a code owner October 9, 2024 17:52
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 9, 2024

🤖 Vercel preview here: https://docs-8zm9257if-goteleport.vercel.app/docs/ver/preview

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 9, 2024

🤖 Vercel preview here: https://docs-pzisfxiqs-goteleport.vercel.app/docs/ver/preview

@hugoShaka
Copy link
Copy Markdown
Contributor

As the proto files were updated, you must re-generate everything that depends on them:

make -C integrations/operator generate manifests crd-docs
make -C integrations/terraform gen-tfschema docs

@eriktate eriktate force-pushed the eriktate/update-terraform-custom-types branch from 584f655 to 707813e Compare October 9, 2024 19:16
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 9, 2024

🤖 Vercel preview here: https://docs-qajlb7hou-goteleport.vercel.app/docs/ver/preview

@eriktate eriktate force-pushed the eriktate/update-terraform-custom-types branch from 707813e to a5bafb5 Compare October 9, 2024 19:59
@eriktate eriktate force-pushed the eriktate/update-terraform-custom-types branch from a5bafb5 to b4c84e3 Compare October 9, 2024 20:00
@eriktate
Copy link
Copy Markdown
Contributor Author

eriktate commented Oct 9, 2024

The prose linter is failing but you can ignore it. Don't rewrite every proto message.

@hugoShaka I unfortunately missed this sentence and I already fixed the prose lint errors 😅 I can revert those if we really don't want to carry them through, but they were all fairly straightforward changes. There weren't really that many of them and pretty much all of them were either capitalizing access list/request or rewriting auth server to Auth Service or Auth Service instance.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 9, 2024

🤖 Vercel preview here: https://docs-m9jwksjzy-goteleport.vercel.app/docs/ver/preview

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 9, 2024

🤖 Vercel preview here: https://docs-7fl00ikyo-goteleport.vercel.app/docs/ver/preview

@eriktate eriktate added this pull request to the merge queue Oct 10, 2024
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Oct 10, 2024
@eriktate eriktate added this pull request to the merge queue Oct 10, 2024
Merged via the queue into master with commit 432b6ae Oct 10, 2024
@eriktate eriktate deleted the eriktate/update-terraform-custom-types branch October 10, 2024 15:32
@public-teleport-github-review-bot
Copy link
Copy Markdown

@eriktate See the table below for backport results.

Branch Result
branch/v14 Failed
branch/v15 Failed
branch/v16 Failed

eriktate added a commit that referenced this pull request Oct 10, 2024
* adding new Attribute param to custom type generator funcs and adjusting
configs to support using protoc-gen-terraform v3.0.0

* generating newly available docs for the terraform provider

* fixing new lint errors
mvbrock pushed a commit that referenced this pull request Oct 16, 2024
* adding new Attribute param to custom type generator funcs and adjusting
configs to support using protoc-gen-terraform v3.0.0

* generating newly available docs for the terraform provider

* fixing new lint errors
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants