Repository navigation
docs: document the repo/commit release fields - #17
Merged
Merged
Conversation
package-protocol-v1.md already documents these correctly, but using-npack.md - the guide most package authors actually follow when building/publishing - never mentioned them: not that they exist, how to set them (no CLI flag on npack init/pack), or that repo must be a NIP-34 30617:<pubkey>:<identifier> address rather than a plain URL. The natural first attempt (a URL, matching how most ecosystems format a repo field) fails at pack/publish time with no pointer back to the actual format. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.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
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.
Closes #16.
Summary
using-npack.md's "Manifest fields" section never mentioned the optionalrepo/commitrelease fields, even thoughpackage-protocol-v1.mddocuments their format correctly.install_inputsparagraph's style) covering: what they're for, the NIP-3430617:<pubkey>:<identifier>format requirement forrepo(not a plain URL), that there's no CLI flag yet so they're set by hand-editing.npack/manifest.json, and a link topackage-protocol-v1.md#release-eventsfor the full tag format.Test plan
package-protocol-v1.md#release-eventsanchor link resolves (matches that file's existing## Release eventsheading).