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

FixDoc Update subnetwork purpose description #11679

Conversation

tferazzi
Copy link
Contributor

@tferazzi tferazzi commented Sep 11, 2024

Update the description of subnetwork purpose parameter.
API docs reference the purpose PRIVATE while the terraform-provider still mentions PRIVATE_RFC_1918. Specifying PRIVATE_RFC_1918 does not result in an error but causes the subnetwork to be re-created on every apply.

Fixes hashicorp/terraform-provider-google#16539

Release Note Template for Downstream PRs (will be copied)


Copy link

google-cla bot commented Sep 11, 2024

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

Copy link

Hello! I am a robot. Tests will require approval from a repository maintainer to run.

@NickElliot, a repository maintainer, has been assigned to review your changes. If you have not received review feedback within 2 business days, please leave a comment on this PR asking them to take a look.

You can help make sure that review is quick by doing a self-review and by running impacted tests locally.

@modular-magician modular-magician added the awaiting-approval Pull requests that needs reviewer's approval to run presubmit tests label Sep 11, 2024
@tferazzi tferazzi force-pushed the chore/subnetwork-purpose-description branch 2 times, most recently from b45bd7c to 186ff17 Compare September 11, 2024 11:52
@modular-magician modular-magician added service/compute-vpc and removed awaiting-approval Pull requests that needs reviewer's approval to run presubmit tests labels Sep 12, 2024
@modular-magician
Copy link
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 2 files changed, 10 insertions(+), 8 deletions(-))
google-beta provider: Diff ( 2 files changed, 10 insertions(+), 8 deletions(-))

@modular-magician
Copy link
Collaborator

Tests analytics

Total tests: 1002
Passed tests: 926
Skipped tests: 75
Affected tests: 1

Click here to see the affected service packages
  • compute

Action taken

Found 1 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests
  • TestAccComputeInstance_confidentialHyperDiskBootDisk

Get to know how VCR tests work

@modular-magician
Copy link
Collaborator

$\textcolor{green}{\textsf{Tests passed during RECORDING mode:}}$
TestAccComputeInstance_confidentialHyperDiskBootDisk[Debug log]

$\textcolor{green}{\textsf{No issues found for passed tests after REPLAYING rerun.}}$


$\textcolor{green}{\textsf{All tests passed!}}$

View the build log or the debug log for each test

Copy link

@NickElliot This PR has been waiting for review for 3 weekdays. Please take a look! Use the label disable-review-reminders to disable these notifications.

Copy link
Contributor

@NickElliot NickElliot left a comment

Choose a reason for hiding this comment

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

Hi, in this case we don't want to alter the actual field behavior because that is adding a maintenance cost for a field which has proven it will change accepted values. Just updating our documentation of what is accepted/not is fine. Thanks for making the update!

Comment on lines 216 to 221
values:
- :PRIVATE
- :REGIONAL_MANAGED_PROXY
- :GLOBAL_MANAGED_PROXY
- :PRIVATE_SERVICE_CONNECT
- :PRIVATE_NAT
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
values:
- :PRIVATE
- :REGIONAL_MANAGED_PROXY
- :GLOBAL_MANAGED_PROXY
- :PRIVATE_SERVICE_CONNECT
- :PRIVATE_NAT

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi, thanks for your review. I removed the commit containing the var change and only kept the documentation updates.

@@ -210,17 +210,23 @@ properties:
immutable: true
required: true
custom_expand: 'templates/terraform/custom_expand/resourceref_with_validation.go.erb'
- !ruby/object:Api::Type::String
- !ruby/object:Api::Type::Enum
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- !ruby/object:Api::Type::Enum
- !ruby/object:Api::Type::String

@tferazzi tferazzi force-pushed the chore/subnetwork-purpose-description branch from 186ff17 to 0891122 Compare September 18, 2024 06:22
@modular-magician modular-magician added the awaiting-approval Pull requests that needs reviewer's approval to run presubmit tests label Sep 18, 2024
Copy link

@NickElliot This PR has been waiting for review for 3 weekdays. Please take a look! Use the label disable-review-reminders to disable these notifications.

Copy link
Contributor

@NickElliot NickElliot left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting-approval Pull requests that needs reviewer's approval to run presubmit tests service/compute-vpc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Subnet purpose documentation out of date?
3 participants