-
-
Notifications
You must be signed in to change notification settings - Fork 7.3k
src: improve tooling around AUTHORS file #9088
Conversation
* in their commits. | ||
*/ | ||
|
||
"use strict"; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1 for using strict mode. Small nit - single quotes are used throughout the rest of the file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated, thanks!
feel free to use https://github.com/iojs/io.js/blob/v1.x/tools/update-authors.sh we're still ordering by first-commit though (I don't see a good reason to order any other way) |
@rvagg Thanks for the heads-up! One thing that I like with writing our tools as Node.js programs is that:
As for ordering alphanumerically instead of by first commit, the reason if I remember correctly is that it's even more "stable" across branches (with first-commit order, you could have the same set of authors but different AUTHORS files for two different branches), and in the end is simpler to reason about. |
fbf87e7
to
f6fa4dc
Compare
@cjihrig Thank you for the preliminary review! I made changes according to your comments, and pushed a more robust and complete version. |
5e5b6a7
to
62e2b26
Compare
8ba77aa
to
4959789
Compare
I ended up not including the automatic generation of a When generating them automatically, it is easy to add bogus entries that further confuse |
8901910
to
b06a010
Compare
I agree with generating the mailmap by hand, there are still some places where humans have better/more context. We can potentially improve the tooling like All in all this is a great step in the maintainable direction -- thanks @misterdjules LGTM |
Replace tools/updateAuthors.awk with tools/update-authors.js. The new tool generates an AUTHORS file that is stable-ordered alphanumerically. Fixes nodejs#9077.
0ba8799
to
387ac80
Compare
Replace tools/updateAuthors.awk with tools/update-authors.js. The new tool generates an AUTHORS file that is stable-ordered alphanumerically. Fixes nodejs#9077. PR: nodejs#9088 PR-URL: nodejs#9088 Reviewed-By: Timothy J Fontaine <tjfontaine@gmail.com>
@tjfontaine Thanks! Landed in 31610d0. |
* build: Fix building with shared zlib. (Bradley T. Hughes) [nodejs#9077](nodejs/node#9077) * stream: fix `Writable` subclass instanceof checks (Anna Henningsen) [nodejs#9088](nodejs/node#9088) * timers: fix regression with clearImmediate() (Brian White) [nodejs#9086](nodejs/node#9086) PR-URL: nodejs/node#9104
* build: Fix building with shared zlib. (Bradley T. Hughes) [nodejs#9077](nodejs/node#9077) * stream: fix `Writable` subclass instanceof checks (Anna Henningsen) [nodejs#9088](nodejs/node#9088) * timers: fix regression with clearImmediate() (Brian White) [nodejs#9086](nodejs/node#9086) PR-URL: nodejs/node#9104
This is a first draft to replace tools/updateAuthors.awk with tools/update-authors.js. The new
tool generates an AUTHORS file that is stable-ordered alphanumerically
(or more precisely "according to unicode code points").
The new tool also generates a .mailmap file that is essentially the same
content as the AUTHORS file, but with all email addresses used by each
author when committing changes to the repo.
As it is currently, the following section:
is removed by this tool, do we want to keep it?
Also, here's the output that shows that the newly generated
.mailmap
andAUTHORS
include all the contributors:@tjfontaine I'm interested in getting initial feedback to know if that corresponds to what you had in mind. If so, then I'll implement the stable-sort part and I'll update the PR.