-
Notifications
You must be signed in to change notification settings - Fork 89
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
Generate hierarchical names under argumentDocs in scraped provider metadata #92
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ulucinar
changed the title
Generate hierarchical names for argumentDocs in scraped provider metadata
Generate hierarchical names under argumentDocs in scraped provider metadata
Sep 6, 2022
ulucinar
force-pushed
the
fix-providers-536
branch
from
September 6, 2022 23:14
ff1c4a4
to
7b4ef8b
Compare
ulucinar
force-pushed
the
fix-providers-536
branch
3 times, most recently
from
September 8, 2022 10:35
f1003bd
to
7561401
Compare
…tadata Signed-off-by: Alper Rifat Ulucinar <[email protected]>
…fields Signed-off-by: Alper Rifat Ulucinar <[email protected]>
ulucinar
force-pushed
the
fix-providers-536
branch
from
September 12, 2022 13:05
7561401
to
5948cf0
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @ulucinar I left a few comments.
ulucinar
force-pushed
the
fix-providers-536
branch
2 times, most recently
from
September 12, 2022 16:25
4d6fb77
to
cfc09af
Compare
Signed-off-by: Alper Rifat Ulucinar <[email protected]>
ulucinar
force-pushed
the
fix-providers-536
branch
from
September 12, 2022 16:34
cfc09af
to
1e0389e
Compare
sergenyalcin
approved these changes
Sep 12, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @ulucinar LGTM!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of your changes
Fixes https://github.com/upbound/official-providers/issues/536
This PR proposes new heuristics in the Terraform provider metadata scraper so that the field (Terraform argument & attribute) names under the
argumentDocs
node will be hierarchical. For example, in the context of https://registry.terraform.io/providers/hashicorp/aws/4.15.1/docs/resources/s3_bucket, instead of generating the following section of the provider metadata file:, which is ambiguous (e.g., there may be multiple
destination
arguments/attributes under different paths:a.destination
,b.destination
, etc.), we now generate:
I have:
make reviewable
to ensure this PR is ready for review.backport release-x.y
labels to auto-backport this PR if necessary.How has this code been tested
Tested with the AWS S3 bucket as follows: