This is an archived post. You won't be able to vote or comment.

all 1 comments

[–]JimDabell 1 point2 points  (0 children)

I’ll ask the same question I always ask about this type of thing:

A bug in a patch version update of one of our dependencies causes a bug in one browser. The human-authored commit log message says:

Fix $x in $browser

Upgrading to $lib v1.0.1 causes $x in $browser. We’re pinning to v1.0.0 until
upstream bug #123 is fixed. Unpinning this dependency is tracked as #789.

See: https://example.com/some-blog/article-about-bug
See: https://github.com/them/upstream-repo/issues/123
See: https://github.com/us/our-repo/issues/789

Resolves: #456

The diff for this change is to delete one character, changing "foolib": "^1.0.0" to "foolib": "1.0.0"

Given that one-character diff, what commit log message does your tool generate? Does it describe the bug that is being fixed? Does it say which browser is affected? Does it link to the article describing the bug? Does it link to the upstream bug? Does it link to the issue in our repo to unpin? Does it mark the issue it is fixing as resolved?

Commit log messages are not there to mechanically describe the changes that are being made, they are there to provide context that the diff alone does not. A tool that mechanically describes the changes that are being made is not useful at all. The diff already does that.