docs: pin to 0.2.0-beta.1 + add pre-release callout#15
Merged
Conversation
Every customer copying the documented `versions.tf` snippet today
hits `terraform init: Failed to query available provider packages:
no available releases match the given constraints "~> 0.1"`. The
provider has only ever shipped pre-release versions
(0.1.0-alpha.1 … 0.1.0-alpha.8), and Terraform's `~>` operator
never selects pre-releases — so the documented constraint matches
zero published versions.
This fix updates four sources of truth and the two
tfplugindocs-generated outputs they drive:
- examples/provider/provider.tf (used by tfplugindocs to render
docs/index.md "Example Usage")
- templates/guides/getting-started.md.tmpl
(renders docs/guides/getting-started.md)
- README.md (npm/GitHub-rendered)
Each replaces `version = "~> 0.1"` with the exact pin
`version = "0.2.0-beta.1"` and adds a short "Pre-release" callout
explaining why an exact pin is required and pointing at the eventual
GA `1.0.0` cut, when `~> 1.0` will become safe.
Bonus: the template's `export DEVHELM_API_TOKEN="dev_…"` placeholder
is updated to `dh_live_…` to match the actual token format the API
issues today.
Pairs with cutting `v0.2.0-beta.1` after this lands. Refs: pre-launch
DevEx agent reports.
Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Every customer copying the documented `versions.tf` snippet today hits:
```
Initializing provider plugins...
╷
│ Error: Failed to query available provider packages
│
│ Could not retrieve the list of available versions for provider
│ devhelmhq/devhelm: no available releases match the given constraints ~> 0.1
╵
```
The provider has only ever shipped pre-release versions (`0.1.0-alpha.1` … `0.1.0-alpha.8`), and Terraform's `~>` operator never selects pre-releases — so the documented constraint matches zero published versions.
Changes
Four sources of truth updated, plus the two tfplugindocs-generated outputs they drive:
Each replaces `version = "
> 0.1"` with the exact pin `version = "0.2.0-beta.1"` and adds a short "Pre-release" callout explaining why an exact pin is required and pointing at the eventual GA `1.0.0` cut, when `> 1.0` will become safe.Bonus: the template's `export DEVHELM_API_TOKEN="dev_…"` placeholder is updated to `dh_live_…` to match the actual token format the API issues.
Test plan
Refs: pre-launch DevEx agent reports — synthesis at `/tmp/devex-cli-test/SYNTHESIS.md`
Made with Cursor