Skip to content

Update Test Generation: new contribution documentation (Relaunch)#17415

Merged
shuyama1 merged 5 commits into
GoogleCloudPlatform:mainfrom
shuyama1:update_test_doc_relaunch
May 7, 2026
Merged

Update Test Generation: new contribution documentation (Relaunch)#17415
shuyama1 merged 5 commits into
GoogleCloudPlatform:mainfrom
shuyama1:update_test_doc_relaunch

Conversation

@shuyama1
Copy link
Copy Markdown
Member

@shuyama1 shuyama1 commented May 4, 2026

Release Note Template for Downstream PRs (will be copied)

See Write release notes for guidance.


@shuyama1 shuyama1 changed the title Update Test Generation: new contribution documentation Update Test Generation: new contribution documentation (Relaunch) May 4, 2026
@modular-magician
Copy link
Copy Markdown
Collaborator

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

Diff report

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

Copy link
Copy Markdown
Collaborator

@BBBmau BBBmau left a comment

Choose a reason for hiding this comment

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

Thought i'd review this after opening the test migration for cloudrun_service:

Comment thread docs/content/test/test.md
## Legacy: Examples-based Framework

> [!WARNING]
> The `examples` block is legacy and has been replaced by `samples`. This footprint is still supported for approximately 2 months to allow for transition. New tests should use the `samples` framework.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

i think it makes sense to mention that the example-based framework still exists currently in magic-modules, but i do wonder if it's even worth including docs on how to add example based testing if the goal is to perform a full migration.

Maybe it makes sense to leave it in the case where samples can't be used, but in that case they could go forward with handwritten.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Thanks for reviewing this!

Yeah, I only plan to keep the example doc around for a few more weeks to help contributors finish their open PRs before removing it. Once that's done and we'll have a couple of more weeks of soak time, and then we’ll drop support for examples entirely and do the final full migration for any remaining resources

@shuyama1 shuyama1 requested a review from melinath May 7, 2026 19:21
@shuyama1 shuyama1 added this pull request to the merge queue May 7, 2026
Merged via the queue into GoogleCloudPlatform:main with commit 76c0c0c May 7, 2026
26 checks passed
@shuyama1 shuyama1 deleted the update_test_doc_relaunch branch May 7, 2026 22:40
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