unisonweb/unison

Add the diff to commit message for auto-created git commits

Open

#1,343 opened on Mar 11, 2020

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Haskell (304 forks)batch import
gitgood first issuehelp wanted

Repository metrics

Stars
 (6,624 stars)
PR merge metrics
 (Avg merge 12d 19h) (6 merged PRs in 30d)

Description

Currently, when doing a push, UCM creates messages like 'Sync branch ' which is not super informative. It is useful to know the namespace hash but it would be nice to know the diff from the previous version as well.

The message comes from here:

https://github.com/unisonweb/unison/blob/master/parser-typechecker/src/Unison/Codebase/Editor/Git.hs#L146-L151

But actually, right in that function we have all we need to be able to at least print out the names diff:

https://github.com/unisonweb/unison/blob/master/parser-typechecker/src/Unison/Codebase/Editor/Git.hs#L135-L137

Printing out the full namespace diff with type signatures etc can be a later project, but there's an easy win here. Just use OutputMessages.prettyDiff to produce a Pretty, which you can convert to text with Pretty.toPlain 80 or whatever width we want to render it at.

I'm not totally sure best way to pass the commit message to git since it's not one line. I guess create a temporary file and pass that file as the commit comment?

Contributor guide

Research direction
Modify the commit message generation in Git.hs (lines 146-151) to include the diff from the previous namespace version. Use OutputMessages.prettyDiff to produce a Pretty, convert to text with Pretty.toPlain 80, and pass the multi line message to git by creating a temporary file.
Tech stack
None
Domain
backenddeveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
HaskellGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75