workspacer-git-commit 0.1.2

A Rust crate to streamline the creation and management of Git commits in applications, simplifying version control processes with easy-to-use abstractions.
Documentation
  • Coverage
  • 0%
    0 out of 1 items documented0 out of 0 items with examples
  • Size
  • Source code size: 140.18 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 232.65 kB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 1m 59s Average build duration of successful builds.
  • all releases: 1m 59s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • klebs6

Workspacer Git Commit

workspacer-git-commit is a Rust crate designed to facilitate interaction with Git repositories through programmatic commit operations. This crate abstracts the complexities of creating and managing Git commits, providing a streamlined interface for handling commit creation in applications with a need for robust version control integration.

Features

  • Create and validate Git commits programmatically.
  • Support for custom commit messages, author identification, and commit signing.
  • Error handling and feedback mechanisms ensure smooth integration into larger systems.

Installation

Add workspacer-git-commit to your Cargo.toml:

[dependencies]
workspacer-git-commit = "0.1.0"

Usage

Import the crate into your project:

use workspacer_git_commit::{CommitBuilder, CommitError};

fn main() -> Result<(), CommitError> {
    let commit = CommitBuilder::new()
        .message("Initial commit")
        .author("Jane Doe", "jane@example.com")
        .create()?;

    println!("Commit created: {}", commit.id());
    Ok(())
}

Technical Background

Git is a distributed version control system that tracks changes in source code during software development. This crate interfaces with Git to abstract and automate commit operations, enhancing developer productivity by enabling seamless integration into complex Rust applications.

License

This crate is licensed under the MIT License. See LICENSE for more details.