mirror of
https://github.com/Slug-Boi/cocommit.git
synced 2026-05-13 12:45:47 +00:00
Slug-Boi
88 lines
4.6 KiB
Markdown
88 lines
4.6 KiB
Markdown
# cocommit
|
|
<p align="center">
|
|
<img src="/icons/logo.png" alt="cocommit logo" width="300" height="300"/>
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://github.com/Slug-Boi/cocommit/releases/latest"> <img src="https://img.shields.io/github/v/release/Slug-Boi/cocommit?logo=github" alt="Github Latest Release" /></a>
|
|
<a href="https://github.com/Slug-Boi/cocommit/actions/workflows/test_push.yml"> <img src="https://img.shields.io/github/actions/workflow/status/Slug-Boi/cocommit/test_push.yml?label=tests" alt="Github Actions Tests" /></a>
|
|
<a href="https://github.com/Slug-Boi/cocommit/actions/workflows/build_test_release.yml"> <img src="https://img.shields.io/github/actions/workflow/status/Slug-Boi/cocommit/build_test_release.yml" alt="Github Actions Build" /></a>
|
|
<a href="https://pkg.go.dev/github.com/Slug-Boi/cocommit"> <img src="https://img.shields.io/badge/_-reference-blue?logo=go&label=%E2%80%8E%20" alt="Go Reference" /></a>
|
|
<a href="https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors"> <img src="https://img.shields.io/badge/Github_Docs-Co--Authoring-grey?logo=github&labelColor=black" alt="Co-Author Docs Github Page" /></a>
|
|
</p>
|
|
|
|
|
|
# How to run
|
|
*Insert blerb about go install if it works*
|
|
|
|
Download the binary for your OS on the [release page](https://github.com/Slug-Boi/cocommit/releases)
|
|
Once downloaded you need to create an alias for your shell guides found below:
|
|
[Bash Guide for alias](https://linuxize.com/post/how-to-create-bash-aliases/)
|
|
*^please note if you use another shell than bash you will need to look up how to do it in that shell^*
|
|
[Powershell Guide for alias](https://stackoverflow.com/questions/24914589/how-to-create-permanent-powershell-aliases)
|
|
|
|
Once you've created an alias for the program you need to create an author file. You can run the program and it will prompt you to create an author file if one is not found in the default location.
|
|
|
|
Optionally you can set an env variable (author_file) in your shell. This should be the path pointing to your authors file
|
|
For bash you just need to add this to your .bashrc file:
|
|
```
|
|
export author_file='path/to/your/aurhors'
|
|
```
|
|
[Powershell guide for env variable](https://stackoverflow.com/a/714918)
|
|
|
|
*Please note that the syntax line at the top of the authors file should not be deleted and that you must add at least one author to the file to run the program*
|
|
|
|
you can now run it using the alias shorthand you assigned to it
|
|
## Usage:
|
|
The CLI has two modes, the CLI commands and the TUI below are guides on how to use both
|
|
|
|
### TUI
|
|
To launch the TUI run the program with no args
|
|
```
|
|
$ cocommit
|
|
```
|
|
From here you will be asked to write a commit message and then select authors from a list. This creates the same message as the CLI way of doing it but is a bit nicer to work with. The TUI has lots of keybinds that can be seen on the list view by pressing `?`. You can create authors, add temp authors or do all of the usual selections like negated selections or select all. Below is a small video showing a run through of the TUI.
|
|
|
|
<a href="https://asciinema.org/a/OFRu5t0A2cSugw49VV6GvumyF" target="_blank"><img src="https://asciinema.org/a/OFRu5t0A2cSugw49VV6GvumyF.svg" /></a>
|
|
|
|
### CLI
|
|
|
|
```
|
|
$ cocommit "message" <name1> [name2] [name3]...
|
|
|
|
$ cocommit "message" <name:email1> [name:email2] [name:email3]...
|
|
|
|
$ cocommit "message" <name:email1> <name1> [name:email2]
|
|
|
|
$ cocommit "message" all
|
|
*adds all comitters execpt ones tagged with ex*
|
|
|
|
$ cocommit "message" ^<name1> ^[name2]
|
|
*adds all users except the negated users and users tagged with ex*
|
|
|
|
$ cocommit "message" <group_name>
|
|
*adds all users that has that group tag in author file*
|
|
|
|
$ cocommit "message"
|
|
*Runs git commit -m "message"*
|
|
|
|
$ cocommit users
|
|
*prints list of users*
|
|
```
|
|
|
|
# Syntax for the author file
|
|
The syntax for the author file can be found at the top of the template file included in the repo. It should look like this (opt) is optional syntax:
|
|
```
|
|
name_short|Name|Username|email (opt: |ex) (opt: ;;group1 or ;;group1|group2|group3...)
|
|
```
|
|
opt explained:
|
|
ex -> excludes the given author for all and negation commands
|
|
group -> groups an author which can then be called as an argument to add all people from that group. An author can be a part of multiple groups
|
|
|
|
# Why?
|
|
Writing co-authors onto commits can be pretty tedious so automating this process as a simple shell alias is a lot nicer
|
|
|
|
# Workflows
|
|
This repo is sort of a test bed for working with Dagger CI but therefore also should support automated testing and building at some point
|
|
*See ci folder for the current dagger workflows*
|
|
|