Skip to content

Add making a breaking change guide#8326

Merged
rileykarson merged 2 commits into
GoogleCloudPlatform:mainfrom
rileykarson:breaking-change-docs
Jul 13, 2023
Merged

Add making a breaking change guide#8326
rileykarson merged 2 commits into
GoogleCloudPlatform:mainfrom
rileykarson:breaking-change-docs

Conversation

@rileykarson

Copy link
Copy Markdown
Member

First pass so far- I'm planning to add some more specific guides and hopefully to make them a little more prescriptive, but this is already a bunch of text so I wanted to push it out to review.

Some of the details on this page conflicted with https://googlecloudplatform.github.io/magic-modules/develop/breaking-changes/, so I've made that page a dedicated "reference" page to explain the detector analyser, and removed duplicated content. Note that I think the reference links are broken as they will still link to deleted files in TPG/TPGB, but they were broken in #8240 and I just haven't fixed 'em here, since this is a documentation change.

Note that most of the content on that page was committed directly to TPG/TPGB and was unreviewed in the first place.

If this PR is for Terraform, I acknowledge that I have:

  • Searched through the issue tracker for an open issue that this either resolves or contributes to, commented on it to claim it, and written "fixes {url}" or "part of {url}" in this PR description. If there were no relevant open issues, I opened one and commented that I would like to work on it (not necessary for very small changes).
  • Ensured that all new fields I added that can be set by a user appear in at least one example (for generated resources) or third_party test (for handwritten resources or update tests).
  • Generated Terraform providers, and ran make test and make lint in the generated providers to ensure it passes unit and linter tests.
  • Ran relevant acceptance tests using my own Google Cloud project and credentials (If the acceptance tests do not yet pass or you are unable to run them, please let your reviewer know).
  • Read Write release notes before writing my release note below.

Release Note Template for Downstream PRs (will be copied)

@modular-magician

Copy link
Copy Markdown
Collaborator

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

Diff report

Your PR hasn't generated any diffs, but I'll let you know if a future commit does.

@modular-magician

Copy link
Copy Markdown
Collaborator

Tests analytics

Total tests: 2853
Passed tests 2550
Skipped tests: 297
Affected tests: 6

Action taken

Found 6 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests
TestAccVertexAIIndex_vertexAiIndexStreamingExample|TestAccVertexAIIndex_vertexAiIndexExample|TestAccContainerAwsNodePool_BetaBasicHandWritten|TestAccComputeFirewallPolicyRule_multipleRules|TestAccBigQueryDataTable_bigtable|TestAccVertexAIIndex_updated

Get to know how VCR tests work

@rileykarson rileykarson requested a review from c2thorn July 12, 2023 20:37
@modular-magician

Copy link
Copy Markdown
Collaborator

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

Rerun these tests in REPLAYING mode to catch issues

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


$\textcolor{red}{\textsf{Tests failed during RECORDING mode:}}$
TestAccVertexAIIndex_vertexAiIndexExample[Error message] [Debug log]
TestAccContainerAwsNodePool_BetaBasicHandWritten[Error message] [Debug log]
TestAccComputeFirewallPolicyRule_multipleRules[Error message] [Debug log]

$\textcolor{red}{\textsf{Please fix these to complete your PR.}}$
View the build log or the debug log for each test

@c2thorn c2thorn left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Read through a few times and can't find anything I'd change.

@rileykarson rileykarson merged commit e3ebcc3 into GoogleCloudPlatform:main Jul 13, 2023
@rileykarson rileykarson deleted the breaking-change-docs branch July 13, 2023 17:31
@ScottSuarez

Copy link
Copy Markdown
Contributor

Notice, this broke the hotlinks for the breaking change detector
#8370 (comment)

https://github.com/GoogleCloudPlatform/magic-modules/pull/8375/files

@ScottSuarez

Copy link
Copy Markdown
Contributor

Note that most of the content on that page was committed directly to TPG/TPGB and was unreviewed in the first place.

This file was previously auto generated by code.

ericayyliu pushed a commit to ericayyliu/magic-modules that referenced this pull request Jul 26, 2023
wj-chen pushed a commit to wj-chen/magic-modules that referenced this pull request Aug 1, 2023
DanielRieske pushed a commit to bschaatsbergen/magic-modules that referenced this pull request Aug 2, 2023
hao-nan-li pushed a commit to hao-nan-li/magic-modules that referenced this pull request Aug 9, 2023
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.

4 participants