use placeholder host in docs and examples #32

Merged
benvin merged 2 commits from benvin/placeholder-host into main 2026-10-17 17:18:48 +11:00
Member

Docs and examples hardcode the real artifactapi service address and a provider source that does not resolve from the registry.

  • replace the endpoint host with artifactapi.example.com in README, docs and examples
  • set example source to artifactapi.example.com/terraform-unkin/artifactapi
Docs and examples hardcode the real artifactapi service address and a provider source that does not resolve from the registry. - replace the endpoint host with artifactapi.example.com in README, docs and examples - set example source to artifactapi.example.com/terraform-unkin/artifactapi
unkin-agent added 1 commit 2026-10-17 15:40:20 +11:00
use placeholder host in docs and examples
ci/woodpecker/pr/build Pipeline was successful
ci/woodpecker/pr/pre-commit Pipeline was successful
ci/woodpecker/pr/test Pipeline was successful
b3a897cc20
Author
Member
  • README.md:24 and Makefile:7 — make install still places the binary at ~/.terraform.d/plugins/git.unkin.net/unkin/artifactapi/... (main.go:21 address also unchanged), but README.md:32 and all 21 examples now use source = "artifactapi.example.com/terraform-unkin/artifactapi", so the documented install does not satisfy the documented source → either keep the original git.unkin.net/unkin/artifactapi source in the install-from-source example, or state that the placeholder source is for the registry install and give the dev-override path separately.
- README.md:24 and Makefile:7 — `make install` still places the binary at `~/.terraform.d/plugins/git.unkin.net/unkin/artifactapi/...` (main.go:21 address also unchanged), but README.md:32 and all 21 examples now use `source = "artifactapi.example.com/terraform-unkin/artifactapi"`, so the documented install does not satisfy the documented source → either keep the original `git.unkin.net/unkin/artifactapi` source in the install-from-source example, or state that the placeholder source is for the registry install and give the dev-override path separately.
unkin-agent added 1 commit 2026-10-17 15:47:57 +11:00
document source address for make install builds
ci/woodpecker/pr/build Pipeline was successful
ci/woodpecker/pr/pre-commit Pipeline was successful
ci/woodpecker/pr/test Pipeline was successful
b89d453cf0
benvin merged commit 25b8f7af14 into main 2026-10-17 17:18:48 +11:00
benvin deleted branch benvin/placeholder-host 2026-10-17 17:18:48 +11:00
Sign in to join this conversation.
No Reviewers
No Label
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: unkin/terraform-provider-artifactapi#32