Config

This is the top level structure that your knope.toml must follow to be valid. If you have a knope.toml in the working directory, and it isn't valid, you'll get an error right off the bat.

Note

For basic workflows, you don't need a config file! Check out the default workflows to see if those work for you first!.

Example

[package]
# Defined set of files to bump using semantic versioning and conventional commits.

[[workflows]]
name = "First Workflow"
# Details here

[[workflows]]
name = "Second Workflow"
# Details here

[jira]
# Jira config here

[github]
# GitHub config here

Info

You can generate a basic config file using knope --generate.

When you first start knope, you will be asked to select a workflow to run. In the above example, this would look something like:

? Select a workflow
> First Workflow
  Second Workflow

You can use your arrow keys to then select an option to run. The > symbol indicates which workflow is selected. Pressing the Enter key on your keyboard will run the workflow.

See Also

  • Packages for details on [package]
  • Workflows for details on defining entries to the [[workflows]] array
  • Jira for details on defining [jira]
  • GitHub for details on defining [github]