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

Improve documentation about upstream provider example string #223

Open
stooj opened this issue Feb 10, 2025 · 0 comments
Open

Improve documentation about upstream provider example string #223

stooj opened this issue Feb 10, 2025 · 0 comments
Labels
kind/enhancement Improvements or new features

Comments

@stooj
Copy link
Contributor

stooj commented Feb 10, 2025

Hello!

  • Vote on this issue by adding a 👍 reaction
  • If you want to implement this feature, comment to let us know (we'll work with you on design, scheduling, etc.)

Issue details

The setup.sh script expects an upstream address for the upstream go module, and as an example suggests hashicorp/terraform-aws.

This example doesn't work:

go.mod:12:2: malformed module path "hashicorp/terraform-provider-aws": missing dot in first path element
Error occurred at ./setup.sh:175. Run with verbose '-v' flag to enable command logging.

I think this string should actually be whatever would work with go get (eg github.com/hashicorp/terraform-aws). Including the whole path will make it clearer how to adapt the example to whatever I'm trying to bridge.

Affected area/feature

  • Setup script
@stooj stooj added kind/enhancement Improvements or new features needs-triage Needs attention from the triage team labels Feb 10, 2025
@mjeffryes mjeffryes removed the needs-triage Needs attention from the triage team label Feb 12, 2025
mjeffryes added a commit that referenced this issue Feb 12, 2025
* Fix usage text in setup.sh

* Also fix the example for upstream

Fixes #222, #223
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement Improvements or new features
Projects
None yet
Development

No branches or pull requests

2 participants