Skip to content

docs: clarify urlTemplate usage and repo_url derivation for registry target#766

Merged
BYK merged 1 commit intomasterfrom
docs/improve-registry-target-docs-v2
Mar 3, 2026
Merged

docs: clarify urlTemplate usage and repo_url derivation for registry target#766
BYK merged 1 commit intomasterfrom
docs/improve-registry-target-docs-v2

Conversation

@BYK
Copy link
Member

@BYK BYK commented Mar 3, 2026

Summary

  • Expands the urlTemplate option description to explain the three Mustache template variables ({{version}}, {{file}}, {{revision}}), clarifies it's for apps/CDN-hosted assets and not typically needed for SDK packages on public registries, and replaces example.com placeholder URLs with realistic downloads.sentry-cdn.com examples.
  • Removes urlTemplate from the SDK entry in the "Creating New Packages" example (SDKs don't need it).
  • Expands the "Manifest Metadata" section into ### repo_url and ### Other metadata subsections, explaining the two-tier resolution for repo_url (auto-detection from origin git remote, with an explicit github: block in .craft.yml as a fallback for edge cases) and noting it's always overwritten on every publish.

@BYK BYK requested a review from s1gr1d March 3, 2026 10:49
@github-actions
Copy link
Contributor

github-actions bot commented Mar 3, 2026

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-03-03 12:17 UTC

@BYK BYK enabled auto-merge (squash) March 3, 2026 10:50
@BYK BYK merged commit d28006e into master Mar 3, 2026
18 checks passed
@BYK BYK deleted the docs/improve-registry-target-docs-v2 branch March 3, 2026 12:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants