Integration with git-duet?

[favna]

I'm trying to introduce commitizen (along with conventional commits, commitlint and husky) in the project I'm working in, however until now we always used git-duet to duet commit our work as we generally use pair programming (programming in a pair of 2). I see no issues, PRs or any talk about integrating commitizen with git-duet so I'll assume it's not yet a feature. I would really appreciate it if it could become one. For example it could be configured in package.json with:

  "config": {
    "commitizen": {
      "path": "./node_modules/cz-conventional-changelog",
      "duet": true
    }
  },

I see some stuff about creating our own entry point script, but I wouldn't know how to integrate git-duet in that as the latter is written in GoLang. There is however also the vscode extension written in TS which hits a bit closer to home as it were but I could definitely still use a leg up on how to implement this properly (https://github.com/philals/git-duet-vscode)

[jimthedev]

Interesting. I haven't used duet before and you are correct no one had probably thought much about this problem. It looks like we'd need to somehow determine whether commitizen or duet would need to execute first since both technically are just wrapping the git cli.

So ultimately you'd probably need a flow something like this (cz and duet might need to be flipped?):

duet        cz                  git commit
--------->
            -----------> make actual commit
            <----------- return status codes and output
<---------

This would allow for the commit to be made by git and then the return codes to be returned to the individual wrapping clis to take action? Either way you're in a scenario where they needs to be a pipeline of sorts that can make sense of all this. In the flow diagram above you would actually make the changes in duet, not commitizen. You'd tell duet to use the commitizen command instead of its normal git subprocess.

Commitizen could also be where that change happens but I'd probably want to know more about if this flow makes sense before introducing it specifically into the api.

[favna]

The primary thing that should be integrated into cz would be to set the committer and author of the commit properly, according to what was set with the git duet or git solo command. These two commands should still be ran manually I'd say. In the future it might be helpful to have cz prompt for authors but as a first release that's not necessary imo. To make an average flow clear here's just a quick sample I whipped up:

 ~/dev -> mkdir temp
 ~/dev -> cd temp
 ~/dev/temp -> git init
Initialized empty Git repository in /Users/favna/dev/temp/.git/
 ~/dev/temp -> git duet jc kh
GIT_AUTHOR_NAME='Jeroen Claassens'
GIT_AUTHOR_EMAIL='j.claassens@cgi.com'
GIT_COMMITTER_NAME='Kevin Hendriks'
GIT_COMMITTER_EMAIL='kevin.hendriks@cgi.com'
 ~/dev/temp -> touch aa.text
 ~/dev/temp -> echo "test" > aa.text
 ~/dev/temp -> git add .
 ~/dev/temp -> git duet-commit -m "test"
[master (root-commit) a57fd5c] test
 Author: Jeroen Claassens <j.claassens@cgi.com>
 1 file changed, 1 insertion(+)
 create mode 100644 aa.text

Showing the details of this commit via tig:

Some more work, but now I virtually solo'd so I use git solo:

 ~/dev/temp -> git solo jc
GIT_AUTHOR_NAME='Jeroen Claassens'
GIT_AUTHOR_EMAIL='j.claassens@cgi.com'
 ~/dev/temp -> echo "test2" >> aa.text
 ~/dev/temp -> git add .
 ~/dev/temp -> git duet-commit -m "after git solo"
[master 04748d6] after git solo
 1 file changed, 1 insertion(+)

And this commit visually:

And then lastly I didn't use git-solo / git-duet at all by not using their git duet-commit command, which as far as I've ever been able to tell is the same as once you've set a git solo, so default behaviour.

~/dev/temp  -> echo "test3" >> aa.text
 ~/dev/temp -> git add .
 ~/dev/temp -> git commit -m "and normal"
[master 8ec4ee4] and normal
 1 file changed, 1 insertion(+)