Skip to main content
Guides

Single-client repos

Generating release notes for a repo with one release stream.

Most repos ship a single product from a single tag stream. ReleaseJet's defaults target this case — no clients config, plain v<semver> tags.

Tag format

Use v<semver>:

  • v1.0.0
  • v1.2.3
  • v2.0.0-beta.1

No tagFormat configuration required — v{version} is the default.

Configuration

provider:
  type: github
categories:
  feature: "New Features"
  bug: "Bug Fixes"
  improvement: "Improvements"
  breaking-change: "Breaking Changes"
uncategorized: lenient

That's the full file. Omit clients entirely.

Generating

releasejet generate --tag v1.2.0 --publish

ReleaseJet finds the previous v* tag on the remote, collects issues closed between the two tag timestamps, and publishes a release.

When to upgrade

If you ship multiple products from the same repo — say a mobile app and a backend API on independent versions — move to multi-client repos.

Multi-client repos

Generating separate release notes per client in a shared monorepo.

Categorizing issues

Mapping issue labels to release note sections.

On this page

Tag formatConfigurationGeneratingWhen to upgrade