Skip to main content

Upgrading

Breaking changes and how to migrate.

Track breaking changes here as they ship. Each entry explains what broke, why, and what to do.

1.x → (no breaking changes yet)

ReleaseJet 1.x is backward-compatible within the major version. Future breaking changes will be documented here with migration steps.

See also: CHANGELOG.

What's new

1.22.0

  • New top-level excludeLabels: string[] config option drops issues carrying any of the listed labels before categorization. Markdown output and webhook envelope both honor the filter.
  • Exclude wins on collision with categories: an issue tagged with both an excluded label and a category label is dropped, not categorized.
  • Excluded issues never trigger uncategorized: strict failures, even when they would otherwise be uncategorized.
  • generate prints a one-line operator summary on stdout when anything was filtered (e.g. Excluded 3 issues by excludeLabels filter (internal, chore)). The line is silent when no issues match. It is not rendered into the release notes.
  • releasejet init now asks "Mark some issues as internal-only (skipped from release notes)?" between contributors and Jira; on yes, prompts for a comma-separated label list (default internal,chore, whitespace-trimmed and deduped).
  • Strictly additive — omit excludeLabels and existing configs behave exactly as before.
  • See Excluding internal issues for the full reference.

1.17.0

  • Four new releasejet auth subcommands for managing ~/.releasejet/credentials.yml from the CLI:
    • auth list-tokens — list every stored token, masked by default (--show-tokens reveals).
    • auth show-token — diagnostic that prints all six resolution steps and which one matched. Use when the wrong token is being picked up.
    • auth remove-token — delete a host, repo, or legacy entry. Mutually-exclusive --host / --repo / --legacy.
    • auth migrate-tokens — interactive walkthrough that copies legacy gitlab: / github: entries into host-keyed entries.
  • All four preserve other top-level YAML keys (notably the Pro pro: license block).
  • See Managing tokens for the full reference.

1.16.0

  • ~/.releasejet/credentials.yml is now keyed by host (e.g. gitlab.com, company.gitlab.com) with optional <host>/<projectPath> per-repo overrides. Use a different token for each self-hosted GitLab instance or for a specific project.
  • New CLI subcommand: releasejet auth set-token — with --host, --repo, or auto-detect from the current repo — writes tokens into the file via a masked prompt.
  • No migration required: legacy gitlab: / github: keys and the bare-text ~/.releasejet/credentials file continue to work as wildcard fallbacks.
  • See Authentication & tokens for the full 6-step token lookup.

1.14.0

  • New description: 'none' | 'extract' | 'ai' top-level config field. When set to extract, release notes render a cleaned, ~200-character excerpt of each issue/PR body under its title. Default is none (no change in output). The ai value is reserved for the Pro M3a plugin and is treated as none in core. See Issue / PR descriptions.