fix: stabilize formatting of autogenerated commits #32
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `git log` command we were using here is sensitive to user-local
configuration (see the "log.decorate" option in `man git-config`, for
example), which means that one user running the update might produce a
commit message like:
Update ckeditor-dev to e1836357e (HEAD, tag: 4.11.4, origin/release/4.11.x) SCAYT/WSC changelog corrected.
and another might produce:
Update ckeditor-dev to e1836357e (tag: 4.11.4) SCAYT/WSC changelog corrected.
Make it totally stable by explicitly providing a format string, which
will make the messages look this this:
Update ckeditor-dev to 4.11.4
e1836357e (tag: 4.11.4) SCAYT/WSC changelog corrected.
The other small improvement here is avoiding the unnecessary fork of a
separate "head" process by passing "-1" to `git log` with equivalent
effect.
Test plan: Run `./ck.sh update` and see that it makes a commit like
this:
commit 92c6594d08a30c242de1f239d73477ebf4964ef9
Author: Greg Hurrell <[email protected]>
Date: Wed Feb 5 09:37:29 2020 +0100
Update ckeditor-dev to 4.13.1
411985373 (tag: 4.13.1) Updated language files.
wincent
force-pushed
the
wincent/no-decorate
branch
from
3cfa2b4
to
29c90a7
Compare
|
Thanks @wincent |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
git logcommand we were using here is sensitive to user-local configuration (see the "log.decorate" option inman git-config, for example), which means that one user running the update might produce a commit message like:and another might produce:
Make it totally stable by explicitly providing a format string, which will make the messages look this this:
The other small improvement here is avoiding the unnecessary fork of a separate "head" process by passing "-1" to
git logwith equivalent effect.Test plan: Run
./ck.sh updateand see that it makes a commit like this: