Configuration Reference

Craft reads its project configuration from .craft.yml, searching the current directory and then its parents. Run craft config to print the parsed and validated result.

minVersion: '2.29.0'
github:
  owner: getsentry
  repo: sentry-javascript
changelog:
  policy: auto
versioning:
  policy: auto
targets:
  - name: npm
  - name: github

Top-level settings

Setting	Description	Guide
minVersion	Minimum Craft version required. Also gates newer behavior.
github	Repository owner and name. Detected from the git remote by default.
targets	Where to publish. List of target configurations.	Targets
changelog	Changelog file path, policy, scope grouping, and AI summaries.	Changelogs
versioning	How the next version is chosen: auto, manual, or calver.	Versioning
preReleaseCommand	Command that bumps versions during craft prepare.	Release Workflow
postReleaseCommand	Command that runs after craft publish.	Release Workflow
postReleaseBump	Bump to the next development version after craft publish.	Release Workflow
releaseBranchPrefix	Release branch prefix. Default: release.	Release Workflow
statusProvider	How Craft checks that CI passed.	Release Workflow
artifactProvider	Where Craft downloads build artifacts from.	Release Workflow
requireNames	Artifacts that must exist before publishing.	Release Workflow
noMerge	Don’t merge the release branch after publishing.	Release Workflow
workspaces	Independently versioned release units in one repository.	Monorepos & Release Workspaces
changelogPolicy	Deprecated. Use changelog.policy.

Inside workspaces, each release unit accepts the same settings except minVersion and workspaces. See Inheritance.

minVersion

Require a minimum Craft version:

minVersion: '2.29.0'

Several features only turn on at or above a given minVersion, so older projects keep their behavior when Craft is upgraded:

minVersion	Enables
2.14.0	Bump types, auto, and calver versions; versioning.policy defaults to auto.
2.21.0	Automatic version bumping when no preReleaseCommand is set.
2.29.0	Release workspaces.
3.8.0	Extra version files with versioning.files.
3.9.0	The pre version for the next prerelease.

github

Craft tries to determine GitHub repo information from the local git repo. You can also hard-code it:

github:
  owner: getsentry
  repo: sentry-javascript

Moved sections

Older links, including the ones printed by earlier Craft versions, point to these anchors. The topics now have their own pages.

Auto mode

See Changelogs → Auto mode and Categories for semver fields.

AI summaries

See AI Changelog Summaries.