Formatter Validator Minifier Escape / Unescape JSON ↔ String JSON ↔ YAML JSON → CSV NDJSON / JSON Lines JSON → Types JSON ↔ XML JSON Diff JSON Patch Canonicalize (RFC 8785) Schema Validator Schema Generator JSONPath Tester JWT Decoder JSON Errors Schemas More Tools
JSONTools / Schema registry / git-cliff
Schema registry

git-cliff

git-cliff configuration file

cliff.toml.cliff.toml**/.config/cliff.tomlcliff.yamlcliff.yml.cliff.yaml.cliff.yml**/.config/cliff.yaml**/.config/cliff.yml
Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your cliff.toml and it validates in your browser — nothing is uploaded.

Validate a cliff.toml → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field Type Description
$schemastringOptional schema URL for editor integrations.
changelogobjectConfiguration options for changelog generation.
changelog.headerstring | null—
changelog.bodystringBody template rendered for each release.
changelog.footerstring | null—
changelog.trimbooleanWhether to remove leading and trailing whitespace from the changelog body.
changelog.render_alwaysbooleanWhether to render the body template even if there are no releases to process.
changelog.postprocessorsarrayRegex-based processors applied after changelog rendering.
changelog.outputstring | null—
gitobjectGit parsing and filtering options.
git.processing_orderoneOfCustom commit processing pipeline.
git.conventional_commitsbooleanWhether to parse commits according to the Conventional Commits specification.
git.require_conventionalbooleanWhether all included commits must be conventional.
git.filter_unconventionalbooleanWhether to exclude commits that are not conventional.
git.split_commitsbooleanWhether each line of a commit should be processed as an individual commit message.
git.commit_preprocessorsarrayRegex-based processors applied before commit parsing.
git.commit_parsersarrayCommit parser rules that classify, scope, or skip commits.
git.protect_breaking_commitsbooleanWhether breaking changes are protected from being skipped by commit parsers.
git.link_parsersarrayRegex-based parsers that extract links from commit messages.
git.filter_commitsbooleanWhether commits not matched by a commit parser are filtered out.
git.fail_on_unmatched_commitbooleanWhether git-cliff should fail when an included commit is not matched by any parser.
git.tag_patternstring | null—
git.skip_tagsstring | null—
git.ignore_tagsstring | null—
git.count_tagsstring | null—
git.use_branch_tagsbooleanWhether to include only tags that belong to the current branch.
git.topo_orderbooleanWhether releases are processed in topological order instead of chronological order.
git.topo_order_commitsbooleanWhether commits are processed in topological order instead of chronological order.
git.sort_commitsstringOrdering for commits inside each release section.
one of: "oldest", "newest"
git.limit_commitsinteger | nullMaximum number of commits included in the generated changelog.
git.recurse_submodulesboolean | null—
git.include_pathsarray<string>—
git.exclude_pathsarray<string>—
remoteobjectGit remote integration options.
remote.offlinebooleanWhether to disable external calls even when remotes are configured.
remote.githubobject—
remote.github.ownerrequiredstringRemote owner or organization.
remote.github.reporequiredstringRemote repository name.
remote.github.tokenstring | null—
remote.github.api_urlstring | null—
remote.github.native_tlsboolean | null—
remote.gitlabobject—
remote.gitlab.ownerrequiredstringRemote owner or organization.
remote.gitlab.reporequiredstringRemote repository name.
remote.gitlab.tokenstring | null—
remote.gitlab.api_urlstring | null—
remote.gitlab.native_tlsboolean | null—
remote.giteaobject—
remote.gitea.ownerrequiredstringRemote owner or organization.
remote.gitea.reporequiredstringRemote repository name.
remote.gitea.tokenstring | null—
remote.gitea.api_urlstring | null—
remote.gitea.native_tlsboolean | null—
remote.bitbucketobject—
remote.bitbucket.ownerrequiredstringRemote owner or organization.
remote.bitbucket.reporequiredstringRemote repository name.
remote.bitbucket.tokenstring | null—
remote.bitbucket.api_urlstring | null—
remote.bitbucket.native_tlsboolean | null—
remote.azure_devopsobject—
remote.azure_devops.ownerrequiredstringRemote owner or organization.
remote.azure_devops.reporequiredstringRemote repository name.
remote.azure_devops.tokenstring | null—
remote.azure_devops.api_urlstring | null—
remote.azure_devops.native_tlsboolean | null—
bumpobjectVersion bumping options.
bump.features_always_bump_minorboolean | null—
bump.breaking_always_bump_majorboolean | null—
bump.initial_tagstring | null—
bump.custom_major_increment_regexstring | null—
bump.custom_minor_increment_regexstring | null—
bump.no_increment_regexstring | null—
bump.bump_typeoneOfForced version bump type.
Audit

What we found in this schema

Standards

Specification sections for the keywords in this schema

Keyword Document Section
$idJSON Schema Core, draft 2020-12§8.2.1 — The "$id" Keyword
$refJSON Schema Core, draft 2020-12§8.2.3.1 — Direct References with "$ref"
$schemaJSON Schema Core, draft 2020-12§8.1.1 — "$schema"
additionalPropertiesJSON Schema Core, draft 2020-12§10.3.2.3 — "additionalProperties"
descriptionJSON Schema Validation, draft 2020-12§9.1 — "title" and "description"
enumJSON Schema Validation, draft 2020-12§6.1.2 — "enum"
itemsJSON Schema Core, draft 2020-12§10.3.1.2 — "items"
oneOfJSON Schema Core, draft 2020-12§10.2.1.3 — "oneOf"
patternJSON Schema Validation, draft 2020-12§6.3.3 — "pattern"
propertiesJSON Schema Core, draft 2020-12§10.3.2.1 — "properties"
requiredJSON Schema Validation, draft 2020-12§6.5.3 — "required"
typeJSON Schema Validation, draft 2020-12§6.1.1 — "type"

Documents

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas