Struct cocogitto::CocoGitto

pub struct CocoGitto { /* private fields */ }

Implementations

impl CocoGitto

pub fn create_monorepo_version(&mut self, opts: BumpOptions<'_>) -> Result<()>

pub fn create_all_package_version_auto( &mut self, opts: BumpOptions<'_> ) -> Result<()>

impl CocoGitto

pub fn create_package_version( &mut self, opts: PackageBumpOptions<'_> ) -> Result<()>

impl CocoGitto

pub fn create_version(&mut self, opts: BumpOptions<'_>) -> Result<()>

impl CocoGitto

pub fn unwrap_or_stash_and_exit<T>(&mut self, tag: &Tag, result: Result<T>) -> T

pub fn get_changelog_with_target_version( &self, pattern: &str, tag: Tag ) -> Result<Release<'_>>

The target version is not created yet when generating the changelog.

pub fn get_package_changelog_with_target_version( &self, pattern: &str, tag: Tag, package: &str ) -> Result<Release<'_>>

The target package version is not created yet when generating the changelog.

pub fn get_monorepo_global_changelog_for_version( &self, pattern: &str, from: OidOf, tag: Tag ) -> Result<Release<'_>>

The target global monorepo version is not created yet when generating the changelog.

impl CocoGitto

pub fn get_changelog( &self, pattern: &str, _with_child_releases: bool ) -> Result<Release<'_>>

Get a changelog between two oids

• from default value:latest tag or else first commit
• to default value:HEAD or else first commit

pub fn get_changelog_at_tag( &self, tag: &str, template: Template ) -> Result<String>

impl CocoGitto

pub fn check( &self, check_from_latest_tag: bool, ignore_merge_commits: bool, range: Option<String> ) -> Result<()>

impl CocoGitto

pub fn conventional_commit(&self, opts: CommitOptions<'_>) -> Result<()>

impl CocoGitto

pub fn check_and_edit(&self, from_latest_tag: bool) -> Result<()>

impl CocoGitto

pub fn get_latest_version( &self, fallback: Option<String>, package: Option<String> ) -> Result<()>

impl CocoGitto

pub fn install_all_hooks(&self, overwrite_existing_hooks: bool) -> Result<()>

pub fn install_git_hooks( &self, overwrite_existing_hooks: bool, hook_types: Vec<GitHookType> ) -> Result<()>

impl CocoGitto

pub fn get_log(&self, filters: CommitFilters) -> Result<String>

pub fn get_repo_tag_name(&self) -> Option<String>

impl CocoGitto

pub fn get() -> Result<Self>

pub fn get_committer(&self) -> Result<String, Git2Error>

pub fn get_conventional_message( commit_type: &str, scope: Option<String>, summary: String, body: Option<String>, footer: Option<String>, is_breaking_change: bool ) -> Result<String>

Tries to get a commit message conforming to the Conventional Commit spec. If the commit message does not conform, None is returned instead.

pub fn run_commit_hook(&self, hook: CommitHook) -> Result<(), Git2Error>

pub fn prepare_edit_message_path(&self) -> PathBuf

pub fn clear_cache(&self)

Trait Implementations

impl Debug for CocoGitto

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

Formats the value using the given formatter.