helpRelease

tcmts.cli.commands.helpRelease · #ctujxig3 · term · runs anywhere

import type { Help } from "#codebase/tcmts/cli/commands";

export const helpRelease: Help = {
  description:
    "release a package: its version and its notes' list of changes come from what changed in its API",
  params: {
    package:
      "<package>[@version], a version past what the changes call for (1.0.0, say); with one package, just @version or nothing",
    draft: "write release-<package>.md to write a summary in, instead of releasing",
    notes: "a markdown file with the summary (default: the draft, if there is one)",
    remote: "where the contributions it brings are (default origin, if there is one)",
    force:
      "release anyway: past a version step too small for the changes, or with work left in tcm todo",
    announce:
      "announce it on the AT Protocol: a codes.tcm.release record in your repository (an existing version: announce that one)",
    source:
      "a server URL people can fetch it from, for --announce (repeatable; kept for next time; default origin's URL)",
    as: "the AT Protocol account to announce as, a handle or DID (signed in in the browser once, then kept; default the last)",
  },
  routes: {
    check: {
      description:
        "what a package's next release would be, and why: each API change, the lint it trips, what it means",
      params: {
        package: "a package (default: the only one)",
      },
    },
    view: {
      description: "a release's notes",
      params: {
        release: "<package>@<version> (or @<version>, with one package)",
      },
    },
  },
}

uses

used by