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).
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:
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.
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.
Knope will also attempt to detect dependencies by package name between members and keep them up to date.
With a workspace like this:
The default knope.toml
file will look like this:
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:
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 [email protected]:knope-dev/knope.git
, Knope will generate a GitHub config:
See forges for more info.