Skip to main content

Module config

Module config 

Source

Structs§

ChangelogConfig
Changelog generation — file, template, and commit grouping.
ChangelogGroup
A named group of commit types for changelog rendering.
ChannelConfig
A named release channel.
ChannelsConfig
Release channels for trunk-based promotion. All channels release from the same branch — channels control the release strategy (stable vs prerelease vs draft), not the branch.
CommitConfig
How commits are classified by semver bump level.
CommitTypesConfig
Commit type names grouped by the semver bump level they trigger. Breaking changes always bump major regardless of configured level.
Config
Root configuration. Six top-level concerns:
GitConfig
Git-level settings — tags and signing.
GitHubConfig
GitHub-specific release settings.
HooksConfig
Package lifecycle hooks — shell commands at release events.
PackageConfig
A releasable package — version files, artifacts, build/publish hooks.
VcsConfig
VCS provider-specific configuration.

Constants§

CONFIG_CANDIDATES
Config file candidates, checked in priority order.
DEFAULT_CONFIG_FILE
Preferred config file name for new projects.
LEGACY_CONFIG_FILE
Legacy config file name (deprecated, will be removed in a future release).

Functions§

default_changelog_groups
default_config_template