Configuration
Every field in .releasejet.yml.
The ReleaseJet config file is .releasejet.yml in your project root. Every field is optional; defaults apply when omitted. Run releasejet init to generate a starter file.
Optional blocks
Most configs only need a handful of fields. The optional top-level blocks are:
provider— git host (GitLab or GitHub) and its base URL.clients— multi-client tag prefix routing. See Multi-client repos.categories— label → section-heading mapping. See Categorizing issues.contributors— append a contributors list. See Contributors section.description— render issue/PR body excerpts. See Issue / PR descriptions.notifications— post to Slack, Discord, or Teams (Pro).jira— link Jira ticket IDs found in issue/PR text (since 1.18.0).
Reference
provider
object
Provider configuration.
Nested fields
provider.type—"gitlab" | "github"— Git hosting provider. "gitlab" or "github".provider.url—string— Base URL of the provider (e.g., https://gitlab.com).
gitlab
object
DEPRECATED: use `provider` instead. Kept for backward compatibility.
Nested fields
gitlab.url—string
source
"issues" | "pull_requests" · default: "issues"
Source for release notes: closed issues or merged pull requests.
clients
array · default: []
categories
object · default: {"feature":"New Features","bug":"Bug Fixes","improvement":"Improvements","breaking-change":"Breaking Changes"}
Map of issue label → section heading.
uncategorized
"lenient" | "strict" · default: "lenient"
How to handle issues without a known category label.
contributors
object
Contributors section configuration.
Nested fields
contributors.enabled—booleancontributors.exclude—array— Usernames to omit from the contributors section.
template
string
Template name ("default", a Pro template, or a path to a .hbs file).
tagFormat
string
Tag format pattern (e.g., "v{version}" or "{prefix}-v{version}").
notifications
array
Webhook notification channels (Pro feature).
description
"none" | "extract" | "ai" · default: "none"
Issue/PR description rendering: "none" (off, default), "extract" (cleaned first paragraph), "ai" (Pro M3a; treated as "none" in core).
projectName
string
Human-readable project name shown in notification cards.
jira
object
Jira ticket linking (F3).
Nested fields
jira.baseUrl—string— Jira instance root URL (e.g., https://acme.atlassian.net).jira.projects—array— Allowlist of Jira project keys (uppercase, e.g., ["PROJ", "BUG"]).