Default config

Knope has some default configuration for things that aren’t specified in a knope.toml file (either when the file isn’t present, or when there are missing sections).

To find out what your project’s default config is, use knope --generate (with no knope.toml file in the current directory).

Tip

Follow the basics tutorial to learn the default workflows hands-on.

Packages

When there are no packages defined in a knope.toml file, Knope tries to find supported packages automatically.

Single package

Most of the time, Knope will look for any supported formats in the current directory and add all of those to a single package:

knope.toml

[package]
versioned_files = ["Cargo.toml", "package.json"]
changelog = "CHANGELOG.md"

The changelog field is only set if there’s a CHANGELOG.md file in the current directory.

Cargo workspaces

If there’s a Cargo.toml file in the current directory that looks like a Cargo workspace, Knope will create a package for each member.

Caution

Only a subset of Cargo workspace features are currently supported, notably members have to be explicitly listed, not using any *.

Cargo.toml

[workspace]
members = ["member1", "member2"]

The names of these packages are from the name in their respective Cargo.toml files, not the directory name. There must be a Cargo.toml file in each member directory, or Knope will error.

member1/Cargo.toml

[package]
name = "something"
version = "0.1.0"

member2/Cargo.toml

[package]
name = "something-else"
version = "0.1.0"

knope.toml

[packages.something]
versioned_files = ["member1/Cargo.toml"]
scopes = ["something"]

[packages.something-else]
versioned_files = ["member2/Cargo.toml"]
scopes = ["something-else"]

Workflows

When there are no workflows defined in a knope.toml file, Knope will use the default workflows. Some pieces will differ depending on the configured packages and forges:

knope.toml

[[workflows]]
name = "release"

[[workflows.steps]]
type = "PrepareRelease"

[[workflows.steps]]
type = "Command"
command = "git commit -m \"chore: prepare release $version\""


[workflows.steps.variables]
"$version" = "Version"

[[workflows.steps]]
type = "Command"
command = "git push"

[[workflows.steps]]
type = "Release"



[[workflows]]
name = "document-change"

[[workflows.steps]]
type = "CreateChangeFile"


[[workflows]]
name = "get-version"
help_text = "Get the current version of the project"

[[workflows.steps]]
type = "Command"
command = "echo \"$version\""

[[workflows.steps.variables]]
"$version" = "Version"

Forges

If there is a knope.toml file, no forges will be configured by default. If there is no knope.toml file, Knope will look at the first Git remote to determine a forge config.

For example, if the first Git remote is git@github.com:knope-dev/knope.git, Knope will generate a GitHub config:

knope.toml

[github]
owner = "knope-dev"
repo = "knope"

See forges for more info.