Skip to content

docs: document the repo/commit release fields #17

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.

Sign up for GitHub

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

Merged
imattau merged 1 commit into from
Sep 23, 2026
Merged

docs: document the repo/commit release fields #17

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/using-npack.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,18 @@ collect values and send them per install. npack checks required fields and
rejects undeclared values, but does not interpret extension types or persist
the supplied values.

Two more optional top-level fields, `repo` and `commit`, link a release to
its source. `commit` is any non-empty commit identifier. `repo` must be a
NIP-34 `30617:<pubkey>:<identifier>` repository address, **not** a plain
URL - `npack pack`/`npack publish` reject anything else with "manifest repo
must be a NIP-34 kind:30617 address". Neither field has a dedicated CLI
flag yet; set them by editing `repo`/`commit` directly in
`.npack/manifest.json` after `npack init`, before `npack pack`. See
[Release events](package-protocol-v1.md#release-events) for the full tag
format - clients may use these for provenance display and repository-state
verification, but source availability is never required to install an
otherwise valid artifact.

An external publishing manifest must contain the final SHA-256:

```bash
Expand Down
Loading