label | string | Yes | | The label the package is indexed under in its namespace. The same as name for a registered artifact or schema; pkg add and pkg update let the two differ |
|---|
name | string | Yes | | The package's name: the second segment of its coordinate for a registered artifact or schema, and the directory its versions sit in under its namespace |
|---|
sourceUri | uri | No | | Where the package comes from, for an entry that points somewhere other than the store holding it. An artifact the store holds carries none: path locates it relative to the store root, and an absolute file URI would name one machine's checkout of the store. |
|---|
type | enum one of local, git | Yes | | How the entry's content is held. local is a file or a directory tree the store keeps; git is a repository cloned from sourceUri and checked out as a git submodule at the entry's place |
|---|
path | path | Yes | | Where the entry's content is, written with forward slashes: the artifact file or the version's directory, relative to the root of the store holding it. For a registered schema, the source document the stored copy was taken from, relative to the directory holding the store where it sits inside it |
|---|
version | version | No | | The version this entry was produced at, in full. An entry reached by its sha is reached without a version key at all, and a version key renders to the store's shape rather than to the whole version, so an entry that does not carry its own version has nowhere to keep the rest of it. |
|---|
sha | string | No | | The source state this entry was produced from, where it was produced from one. A version says what was built; a sha says which source it was built out of, which is what makes two entries at one version distinguishable and what a build cache looks up. |
|---|
shaKind | enum one of commit, gittree, tree, built | No | | How the sha was arrived at: commit is a clean checkout's own commit, gittree a checkout carrying uncommitted changes, tree a directory that is not a git repository at all, and built a digest of one of those together with the other states the artifact was built from, which names no source on its own. It does not change a lookup, since a reader computes the key the same way whichever it is; it is recorded because a gittree entry is a build of source that no commit holds, which is what someone reading a surprising cache hit needs to see. |
|---|
digest | string | No | | The sha256 of the file path names, in hexadecimal, where the entry is one file a store holds: what a reader that fetched the file from somewhere else checks it against. sha says which source an artifact was built from and nothing about its bytes. Absent from an entry that is a directory, from one whose path names a source document, and from one written before the field existed; an entry carrying none is not checked. |
|---|
registeredAt | datetime | No | | When this entry was written into the index. A sha key is content rather than a clock, so it puts two builds of one version in no order at all; this is the order retention reads -- keep the most recent N, or clear what predates a cutoff. Optional because an entry written before the field existed carries none, and an entry carrying none is the oldest there is. |
|---|
releaseNotes | releaseNotes | No | | What the release this entry belongs to changed, and what a deployer has to know before taking it, as the release drafted them for its review. Every entry one release files carries the same notes, so a consumer holding any of them holds the release's notes, and one comparing two versions reads the notes of each version between them. Absent from an entry no release drafted notes for: a build, a development registration, or a release published before the field existed. |
|---|
clientNotes | clientNotes | No | | What the release this entry belongs to means for a client, where the entry is something a client receives and the release is one chosen for them: drafted when the release goes public, from the release's own notes and those of everything it bundles, back to the last release clients received. Where releaseNotes is written for the people who build the tree and names their pull requests, this names nothing a client does not use. Absent from an entry clients do not receive, and from a release that has not gone public. |
|---|
dependencies | list[releaseDependency] | No | | What the release this entry belongs to was released against: each library and schema its repository resolved, other than tooling, at the released version whose source matches what resolved. Every entry one release files carries the same list. Absent from an entry that is not a release, and from a release published before the field existed; an empty list is a release that depends on nothing. |
|---|
audience | enum one of public, internal | No | | Who the release this entry belongs to is for: internal is a release the tree cut for its own repositories, public one chosen for clients. Every entry one release files carries the same audience, and promoting a release rewrites it on each of them. It is about the release, where a module's own audience is about the module: a public module in an internal release has not been shipped to anybody. Absent from an entry that is not a release, and from a release published before the field existed, which is read as internal. |
|---|
executableForm | enum one of bundled, compiled | No | | What an executable entry is, as the build that made it says: bundled is the interpreter and the application's bytecode put together, which anybody holding it can read back into source and which is therefore never handed to a client; compiled is the application translated to native code, the only form a client is handed. Two entries of one application at the same commits, version and platform differ by this alone, so a reader that cares which it holds asks it rather than the name. Absent from an entry that is no executable, and from one filed before the field existed, which is read as bundled. |
|---|
signedWith | enum one of authenticode, sigstore | No | | How an executable a client is handed was signed before it was filed, so its digest is of the signed artifact: authenticode, a Windows signature inside each signed file, checked by the system that runs it; sigstore, a detached Sigstore bundle filed inside the artifact beside the executable it signs, as <executable>.sigstore.json. Absent from an entry that was not signed, which no executable a client is handed may be. |
|---|
treeSha | string | No | | The commit of the tree an executable was built in, beside sha, the commit of its own repository: a build is of one source only where every platform's was made at the same pair, so an executable a release of the tree is handed records both and is checked against both. Absent from an entry that was not built in a tree, which is every entry but a compiled executable a client is handed. |
|---|
languageVersions | versionRange | No | | The versions of its language a repo adapter is for, as the adapter states them: a version, a list read as the span from its lowest item to its highest, or bounds joined by a comma. Recorded by the release that files the entry, on a language core and on each adapter that configures one, so a reader choosing among releases can tell which is for a repository without unpacking any of them. Absent from an entry that is no adapter's, from a build, and from a release published before the field existed; an entry carrying none is for every version. |
|---|
readme | string | No | | The README at the root of the module this entry was released from, as the released commit holds it: the module's client documentation, which its archive carries and which a reader holding only the catalog reaches by the module's coordinate. A release records it on the entry of each module declared public and on no other entry it files, so it is the module's where the notes are the release's. A relative link in it is followed from the module's root and names a file inside the module. Absent from an entry of an internal module, from one that is not a release, and from a release published before the field existed. |
|---|