dev.knotless.release Documentation (EN)

main record

Kept in the repository owner's account, keyed `<repo key>.<package hash>.<version hash>`, where each hash is the first 26 characters of the lowercase unpadded base32 SHA-256 of `package` or `version`, so a listing from the cursor `<repo key>/` walks one repository's releases, and from `<repo key>.<package hash>/` one package's. Created and never updated: creating it fails if that version was published, so a version's files never change. Deleting it unpublishes the version. Readers check every file against its `sha256`.

Record Key any Any valid record key

Properties

check string at-uri Optional

The dev.knotless.check, in its runner's account, of the run that built and published it. A reader trusts it only from a runner the repository names, and only once it has passed at `commit`.

commit string Optional

The hex object ID of the commit the files were built from.

maxLength: 64 bytesminLength: 40 bytes

createdAt string datetime Required

An RFC 3339 formatted timestamp.

files array of ref #file Required

What it publishes, by distinct names.

maxLength: 64 itemsminLength: 1 items

notes string Optional

What changed since the version before, in Markdown, as the changelog says.

maxLength: 20000 bytesmaxGraphemes: 5000 graphemes

package string Required

The package's name, as npm's rules have it: lowercase letters, digits, `-`, `.`, `_` and `~`, after an optional `@scope/`. A repository can publish several.

maxLength: 214 bytesminLength: 1 bytes

repo string tid Required

The `key` of the dev.knotless.repo that publishes it.

version string Required

A Semantic Versioning 2.0 version, such as 1.4.0 or 2.0.0-rc.1. The highest version without a pre-release part is the package's latest.

maxLength: 256 bytesminLength: 5 bytes

View raw schema

{
  "description": "Kept in the repository owner's account, keyed `<repo key>.<package hash>.<version hash>`, where each hash is the first 26 characters of the lowercase unpadded base32 SHA-256 of `package` or `version`, so a listing from the cursor `<repo key>/` walks one repository's releases, and from `<repo key>.<package hash>/` one package's. Created and never updated: creating it fails if that version was published, so a version's files never change. Deleting it unpublishes the version. Readers check every file against its `sha256`.",
  "key": "any",
  "record": {
    "properties": {
      "check": {
        "description": "The dev.knotless.check, in its runner's account, of the run that built and published it. A reader trusts it only from a runner the repository names, and only once it has passed at `commit`.",
        "format": "at-uri",
        "type": "string"
      },
      "commit": {
        "description": "The hex object ID of the commit the files were built from.",
        "maxLength": 64,
        "minLength": 40,
        "type": "string"
      },
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "files": {
        "description": "What it publishes, by distinct names.",
        "items": {
          "ref": "#file",
          "type": "ref"
        },
        "maxLength": 64,
        "minLength": 1,
        "type": "array"
      },
      "notes": {
        "description": "What changed since the version before, in Markdown, as the changelog says.",
        "maxGraphemes": 5000,
        "maxLength": 20000,
        "type": "string"
      },
      "package": {
        "description": "The package's name, as npm's rules have it: lowercase letters, digits, `-`, `.`, `_` and `~`, after an optional `@scope/`. A repository can publish several.",
        "maxLength": 214,
        "minLength": 1,
        "type": "string"
      },
      "repo": {
        "description": "The `key` of the dev.knotless.repo that publishes it.",
        "format": "tid",
        "type": "string"
      },
      "version": {
        "description": "A Semantic Versioning 2.0 version, such as 1.4.0 or 2.0.0-rc.1. The highest version without a pre-release part is the package's latest.",
        "maxLength": 256,
        "minLength": 5,
        "type": "string"
      }
    },
    "required": [
      "repo",
      "package",
      "version",
      "files",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}

file object

One file of a release.

Properties

name string Required

Its name, as it is downloaded: letters, digits, `.`, `_`, `+` and `-`, not first a `.`.

maxLength: 255 bytesminLength: 1 bytes

parts array of ref#part Required

The file, split over blobs in order, each no larger than its PDS takes.

minLength: 1 items

sha256 string Required

The lowercase hex SHA-256 of the file.

maxLength: 64 bytesminLength: 64 bytes

size integer Required

Bytes in the file.

minimum: 1

View raw schema

{
  "description": "One file of a release.",
  "properties": {
    "name": {
      "description": "Its name, as it is downloaded: letters, digits, `.`, `_`, `+` and `-`, not first a `.`.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "parts": {
      "description": "The file, split over blobs in order, each no larger than its PDS takes.",
      "items": {
        "ref": "#part",
        "type": "ref"
      },
      "minLength": 1,
      "type": "array"
    },
    "sha256": {
      "description": "The lowercase hex SHA-256 of the file.",
      "maxLength": 64,
      "minLength": 64,
      "type": "string"
    },
    "size": {
      "description": "Bytes in the file.",
      "minimum": 1,
      "type": "integer"
    }
  },
  "required": [
    "name",
    "size",
    "sha256",
    "parts"
  ],
  "type": "object"
}

part object

One blob of a file, in order.

Properties

blob blob Required

No description available.

View raw schema

{
  "description": "One blob of a file, in order.",
  "properties": {
    "blob": {
      "accept": [
        "application/octet-stream"
      ],
      "type": "blob"
    }
  },
  "required": [
    "blob"
  ],
  "type": "object"
}