git-z

A Git extension to go beyond.

Setup

Installation

With Nix:

nix profile install github:ejpcmac/git-z

With Cargo:

cargo install git-z

Usage

Run:

git add <your modifications>
git z commit

You can define a list of valid commit types, scopes, ticket prefixes and a commit template by using a git-z.toml file at the root of your repository:

version = "0.1"
types = ["chore", "docs", "feat", "fix", "refactor", "revert", "style", "test"]
scopes = ["backend", "frontend"]
ticket_prefixes = [""]

template = """
{{ type }}{% if scope %}({{ scope }}){% endif %}{% if breaking_change %}!{% endif %}: {{ description }}

# Feel free to enter a longer description here.

Refs: {{ ticket }}

{% if breaking_change %}BREAKING CHANGE: {{ breaking_change }}{% endif %}
"""

For a more detailed description, please look at commits.toml.sample.

Building an installer

Linux (Debian)

With Docker installed on your machine, you can run:

$ ./build-deb.sh

You should then find a Debian package in target/debian/.

Windows

With a Rust toolchain instalded on your machine, you can:

Install WiX v3.

Run:

 > cargo install cargo-wix
 > cargo wix --nocapture

You should find an installer in target/wix/.

Contributing

Before contributing to this project, please read the CONTRIBUTING.md.

License

This project is licensed under the GNU General Public License 3.0.

git-z 0.1.0