Update contributor docs to recommend dev overrides #7130
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
|
Commit c61af27 changes the updates to use-built-provider.md because it looks like the Makefile in the downstreams still has |
melinath
requested changes
Jan 20, 2023
Co-authored-by: Stephen Lewis (Burrows) <stephen.r.burrows@gmail.com>
Co-authored-by: Stephen Lewis (Burrows) <stephen.r.burrows@gmail.com>
rileykarson
reviewed
Jan 24, 2023
…g using TF_LOG env
Co-authored-by: Riley Karson <rileykarson@google.com>
melinath
approved these changes
Jan 25, 2023
Co-authored-by: Stephen Lewis (Burrows) <stephen.r.burrows@gmail.com>
melinath
requested changes
Jan 25, 2023
melinath
approved these changes
Jan 25, 2023
ericayyliu
pushed a commit
to ericayyliu/magic-modules
that referenced
this pull request
Jul 26, 2023
…rm#7130) * Update contributor docs to recommend dev overrides * Revert `make provider` to `make build` in docs about building binaries * Update docs/content/docs/getting-started/use-built-provider.md Co-authored-by: Stephen Lewis (Burrows) <stephen.r.burrows@gmail.com> * Update docs/content/docs/getting-started/use-built-provider.md Co-authored-by: Stephen Lewis (Burrows) <stephen.r.burrows@gmail.com> * Replace example username with gender neutral example * Remove unneeded section, update opening paragraph(s) with URL from unneeded section * Add warning about developer overrides needing v0.14+ * Return section advising how to clean up a filesystem mirror, and debug using TF_LOG env * Update docs/content/docs/getting-started/use-built-provider.md Co-authored-by: Riley Karson <rileykarson@google.com> * Apply suggestions from code review - `make provider` Co-authored-by: Stephen Lewis (Burrows) <stephen.r.burrows@gmail.com> * Revert `make provider` to `make build` in docs about building binaries Co-authored-by: Stephen Lewis (Burrows) <stephen.r.burrows@gmail.com> Co-authored-by: Riley Karson <rileykarson@google.com>
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
Closes hashicorp/terraform-provider-google#13404
This PR updates the 'Use built provider locally' page of the contributor docs to recommend developer overrides for use during development.
I've decided to remove the old guidance about file system mirrors and put a smaller version of that guidance in the 'More information' section at the bottom. Mainly this is because using developer overrides is the approach recommended by HashiCorp and has advantages like being more explicit and not requiring users to create a fake version number for their local version of the provider.
Screenshots
Note: became outdated after responding to review
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).Generated Terraform, and ranmake testandmake lintto ensure it passes unit and linter tests.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).Ran relevant acceptance tests (If the acceptance tests do not yet pass or you are unable to run them, please let your reviewer know).Read the Release Notes Guide before writing my release note below.Release Note Template for Downstream PRs (will be copied)