Enum git_checks::config::ChangelogConfig
source · [−]pub enum ChangelogConfig {
// some variants omitted
}
Expand description
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
sourceimpl Debug for ChangelogConfig
impl Debug for ChangelogConfig
sourceimpl<'de> Deserialize<'de> for ChangelogConfig
impl<'de> Deserialize<'de> for ChangelogConfig
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl IntoCheck for ChangelogConfig
impl IntoCheck for ChangelogConfig
sourcefn into_check(self) -> Self::Check
fn into_check(self) -> Self::Check
Create a new instance of the check from the configuration.
Auto Trait Implementations
impl RefUnwindSafe for ChangelogConfig
impl Send for ChangelogConfig
impl Sync for ChangelogConfig
impl Unpin for ChangelogConfig
impl UnwindSafe for ChangelogConfig
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more