Interface BumpyConfig

packages/bumpy/src/types.ts:126–195

}

export interface BumpyConfig {
  baseBranch: string;
  access: 'public' | 'restricted';
  /**
   * Prerelease channels, keyed by channel name. Each maps a long-lived branch
   * to a prerelease line (version suffix + npm dist-tag). Shipped bump files
   * are tracked in `.bumpy/<name>/`. Prerelease versions are never committed —
   * they are derived from bump files, the registry, and git tags at publish time.
   */
  channels: Record<string, ChannelConfig>;
  /**
   * Snapshot release settings. Snapshots publish the pending release plan transiently
   * under a throwaway dist-tag (e.g. for previewing a PR from a private registry) without
   * consuming bump files, writing changelogs, committing, or tagging. See `bumpy publish --snapshot`.
   */
  snapshot: SnapshotConfig;
  /**
   * Customize the commit message used when versioning.
   * A string starting with "./" is treated as a path to a module that exports
   * a function receiving the release plan and returning a message string.
   * Any other string is used as a static commit message.
   * Omit to use the default: "Version packages\n\npkg@version..."
   */
  versionCommitMessage?: string;
  changelog: false | string | [string, Record<string, unknown>];
  fixed: string[][];
  linked: string[][];
  /** Glob patterns to filter which changed files count toward marking a package as changed */
  changedFilePatterns: string[];
  /**
   * Top-level `package.json` fields whose change alone does NOT mark a package as
   * changed (i.e. doesn't require a bump file). When `package.json` is the only changed
   * file in a package, bumpy diffs it against the base branch and ignores changes
   * confined to these fields. Default: `["devDependencies"]` — dev-only dependency
   * updates (e.g. Dependabot) don't affect published output. Exception: a changed
   * `devDependencies` entry that matches the package's `releaseTriggeringDevDeps` still
   * counts, since it ships in the bundle.
   */
  ignoredPackageJsonFields: string[];
  /** Package names/globs to exclude from version management */
  ignore: string[];
  /** Package names/globs to explicitly include (overrides private + ignore) */
  include: string[];
  updateInternalDependencies: 'patch' | 'minor' | 'out-of-range';
  dependencyBumpRules: Partial<Record<DepType, DependencyBumpRule | false>>;
  privatePackages: { version: boolean; tag: boolean };
  /**
   * Allow per-package custom commands (buildCommand, publishCommand, checkPublished)
   * defined in package.json "bumpy" fields.
   * Commands defined in the root config's `packages` map are always trusted.
   *
   * true = allow all packages to define custom commands
   * string[] = allow only matching package names/globs
   * false = only root-config commands are allowed (default)
   */
  allowCustomCommands: boolean | string[];
  packages: Record<string, PackageConfig>;
  publish: PublishConfig;