Configuration reference

The config reference list all value that can be set in the cog.toml file at the root of a repository.

General

tag_prefix

  • Type: String

  • Optional: true

  • Description: set a tag prefix value for cocogitto. For instance if you have a v as a tag prefix, cocogitto will generate version starting with v and commands like cog changelog will pick only those versions.

  • Example:

    tag_prefix = "v"
    
  • Also see:

    User guide -> Tag prefix

branch_whitelist

  • Type: Array<String>

  • Optional: true

  • Description: A list of glob patterns to allow bumping only on matching branches.

  • Example:

    branch_whitelist = [ "main", "release/**" ]
    
  • Also see:

    User guide -> Branch whitelist

ignore_merge_commits

commit_types

  • Type: Hashmap<String, ChangelogTitle>

  • Optional: true

  • Description: extend the allowed commit types, creating a new cog commit command and allowing to generate changelog entries for the given type.

  • Example:

    [commit_types]
    hotfix = { changelog_title = "Hotfixes" }
    release = { changelog_title = "Releases" }
    
  • Also see:

    User guide -> Custom commit types

Bump config

pre_bump_hooks

post_bump_hooks

bump_profiles

Changelog

path

template

  • Type: String

  • Optional: true

  • Default value: "default"

  • Description: name of the builtin template to use for changelog generation or path to a custom template. Note that remote, repository and owner are mandatory if the "remote" built-in template us used or if your custom template make use of those variables.

  • Built-in templates : default, remote, full_hash

  • Example:

    [changelog]
    template = "full_hash"
    
  • Also see:

remote

repository

owner

authors

  • Type: Array<Author>

  • Optional: true

  • Description: A list of commit authors with their git signature and git platform username to generate Markdown links in changelogs.

  • Example:

      [changelog]
      authors = [
        { signature = "Paul Delafosse", username = "oknozor" },
        { signature = "Jack Dorland", username = "jackdorland" },
        { signature = "Mike Lubinets", username = "mersinvald" },
        { signature = "Marcin Puc", username = "tranzystorek-io" },
        { signature = "Renault Fernandes", username = "renaultfernandes" },
        { signature = "Pieter Joost van de Sande", username = "pjvds" },
        { signature = "orhun", username = "orhun" },
        { signature = "Danny Tatom", username = "its-danny" },
    ]
    
  • Also see: