docs: add note about acceptance tests #2737
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
[upstream:eee25d36162400989019fbfd23aaafbd7e864e3f] Signed-off-by: Modular Magician <[email protected]>
modular-magician
requested review from
shuyama1
and removed request for
a team
modular-magician
deleted the
downstream-pr-eee25d36162400989019fbfd23aaafbd7e864e3f
branch
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.
While it is probably obvious, it may be good to provide a reminder to people about acceptance tests, to make sure they understand to use a temporary / sandbox project, and to keep an eye out for stray resources (ask me how I was reminded about this sometime 🙃).
For folks outside of Google's ecosystem, this is probably particularly important, especially as some tests create resources that can generate significant costs.
(I assume the
NOTEsyntax shows up Ok under GH pages as well, but may be worth double checking; not sure if any of these docs specifically also show up under the tf registry, but assuming not?)Release Note Template for Downstream PRs (will be copied)
Derived from GoogleCloudPlatform/magic-modules#11475