Enum ChangelogConfig

pub enum ChangelogConfig {
    // some variants omitted
}

Configuration for the Changelog check.

Requires the style key which indicates what style of changelog is used. Must be one of "directory" or "file".

For both styles, the path key is required. This is the path to the file or directory containing changelog information. The required key is a boolean that defaults to false. The directory style also has an optional extension key which is a string that changelog files in the directory are expected to have.

This check is registered as a commit check with the name "changelog" and a topic check with the name "changelog/topic".

Examples

{
    "style": "directory",
    "path": "path/to/directory",
    "extension": "md",
    "required": false
}

{
    "style": "file",
    "path": "path/to/changelog.file",
    "required": false
}

{
    "style": "files",
    "paths": [
        "path/to/first/changelog.file"
        "path/to/second/changelog.file"
    ],
    "required": false
}

Trait Implementations

impl Debug for ChangelogConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChangelogConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoCheck for ChangelogConfig

type Check = Changelog

The check parsed by this configuration.

fn into_check(self) -> Self::Check

Create a new instance of the check from the configuration.