GitHub provides a mechanism to create commits with multiple authors, which are visible on GitHub interface. However, git does not have a built-in command to execute this action easily. This project comes up with a Git Alias in order to create Co-authored commits using the command line.
Add alias located at the config file to the bottom of one of the following git configuration file:
- For global scope :
~/.gitconfigor~/.config/git/config - For system scope :
/etc/gitconfig - For project scope :
.git/config
[alias]
co-commit = "!co_authored_commit(){ usage='usage: git commit -m \"Commit message\" --co \"co_author_name\"\n'; while [ \"${#}\" -gt 0 ]; do case \"${1}\" in -m) shift; message="${1}"; shift;; --co) shift; co_author=\"Co-authored-by: \"${1}\"\n\"; co_authors=\"${co_authors}${co_author}\"; shift;; *) shift;; esac; done; if [ -z \"${co_authors}\" ]; then echo ${usage}; exit 1; fi; if [ -z \"${message}\" ]; then echo ${usage}; exit 1; fi; co_authored_message=\"${message}\n\n\n${co_authors}\"; git commit -m \"${co_authored_message}\"; }; co_authored_commit"
After the installation step, you are able to perform the following command:
$ git co-commit -m "Commit message" --co "co-author <co-author-email>"
The -m flag is the commit message flag, the same as the git commit command.
The --co flag is passed to inform both co-author name and email. If one chooses to keep their email private, use <no-reply> instead.
If you pass --co flag with co author email both will be authors, otherwise only the person who commited will be seen by github.
You can see the first commit here and the second here.
It is possible to pass multiple --co flags.
$ git co-commit -m "this is my commit message" --co "username <username@email.com>"
For now, it is mandatory to pass the the git commit message flag.
This repository is licensed under GPL-3.0