changelogging

changelogging configuration file

Type object
File match **/changelogging.toml
Schema URL https://catalog.lintel.tools/schemas/schemastore/changelogging/latest.json
Source https://raw.githubusercontent.com/nekitdev/changelogging/main/changelogging.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

changelogging configuration file.

Properties

context object required

Represents contexts of projects.

3 nested properties
name string required
minLength=1
version string required
minLength=1
url string required
minLength=1
paths object

Specifies locations of fragments and the changelog.

2 nested properties
directory string
minLength=1
output string
minLength=1
start NonEmptyString

Marks the location in the changelog to start writing entries after.

levels object

Defines which heading levels to use.

2 nested properties
entry integer
min=1
section integer
min=1
indents object

Specifies which characters to use for indenting.

2 nested properties
heading string
minLength=1maxLength=1
bullet string
minLength=1maxLength=1
formats object

Defines formats to use for rendering entry titles and fragments.

2 nested properties
title string
minLength=1
fragment string
minLength=1
wrap integer
min=1
order NonEmptyString[]

Defines which types to include, and in what order.

types object

Maps types to their titles.

Definitions

Context object

Represents contexts of projects.

name string required
minLength=1
version string required
minLength=1
url string required
minLength=1
Paths object

Specifies locations of fragments and the changelog.

directory string
minLength=1
output string
minLength=1
NonEmptyString string
Start string
Level integer
Levels object

Defines which heading levels to use.

entry integer
min=1
section integer
min=1
Character string
Indents object

Specifies which characters to use for indenting.

heading string
minLength=1maxLength=1
bullet string
minLength=1maxLength=1
Formats object

Defines formats to use for rendering entry titles and fragments.

title string
minLength=1
fragment string
minLength=1
Wrap integer
Order NonEmptyString[]

Defines which types to include, and in what order.

Types object

Maps types to their titles.