Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tools: clarify commit message linting #23742

Closed
wants to merge 2 commits into from

Conversation

@Trott
Copy link
Member

commented Oct 18, 2018

Clarify in Travis results that the commit message linting is for the
commit message and not something else.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • commit message follows commit guidelines
@Trott Trott referenced this pull request Oct 18, 2018
3 of 3 tasks complete
.travis.yml Outdated
@@ -13,7 +13,7 @@ matrix:
script:
- make lint
# Lint the first commit in the PR.
- git log $TRAVIS_COMMIT_RANGE --pretty=format:'%h' --no-merges | tail -1 | xargs npx core-validate-commit --no-validate-metadata
- echo 'Linting the commit message...' && git log $TRAVIS_COMMIT_RANGE --pretty=format:'%h' --no-merges | tail -1 | xargs npx -q core-validate-commit --no-validate-metadata

This comment has been minimized.

Copy link
@refack

refack Oct 18, 2018

Member

I think that at his point you should promote this to either a script in tools, or a Makefile target.
That will also allow manual checks

This comment has been minimized.

Copy link
@Trott

Trott Oct 18, 2018

Author Member

Maybe. There is, however, a reliance on a Travis-specific environment variable....

This comment has been minimized.

Copy link
@refack

refack Oct 18, 2018

Member

A script could be parameter based...
Or maybe move the logic into core-validate-commit.
It would be nice to be able to just do npx core-validate-commit and get an answer.

@Trott

This comment has been minimized.

Copy link
Member Author

commented Oct 18, 2018

Here's what the updated friendly message looks like:

screen shot 2018-10-18 at 4 29 02 pm

@refack

This comment has been minimized.

Copy link
Member

commented Oct 18, 2018

Could you add:

\n
Linting the commit message according to the guidelines at https://goo.gl/p2fr5Q
\n

@refack refack added test meta labels Oct 18, 2018

tools: clarify commit message linting
Clarify in Travis results that the commit message linting is for the
commit message and not something else.

@Trott Trott force-pushed the Trott:commitments branch from 09fc13e to 1b7dfea Oct 18, 2018

@richardlau

This comment has been minimized.

Copy link
Member

commented Oct 18, 2018

Could you add:

\n
Linting the commit message according to the guidelines at https://goo.gl/p2fr5Q
\n

I'd prefer a non-obfuscated URL.

@refack

This comment has been minimized.

Copy link
Member

commented Oct 18, 2018

I'd prefer a non-obfuscated URL.

It's kinda horible https://github.com/nodejs/node/blob/master/doc/guides/contributing/pull-requests.md#commit-message-guidelines

@Trott

This comment has been minimized.

Copy link
Member Author

commented Oct 18, 2018

I put in the shortened URL for now. We can always switch in the non-obfuscated one later, but it is about 110 characters long.... 😱

@refack
refack approved these changes Oct 18, 2018
@Trott

This comment has been minimized.

Copy link
Member Author

commented Oct 18, 2018

(By the way: Thanks everyone for patiently working with this. I know it's caused more questions and confusion than anything else up until now, which is unfortunate. Hopefully this and the other thing that just landed will make it valuable...)

@Trott

This comment has been minimized.

Copy link
Member Author

commented Oct 18, 2018

Here's what it looks like now:

screen shot 2018-10-18 at 4 46 28 pm

@refack

This comment has been minimized.

Copy link
Member

commented Oct 18, 2018

Ohh I just had an idea how to workaround Travis's Pass/Fail limitation. Use the node-bot; curl it with parameters so it could post a comment in the PR thread.

@refack refack added the fast-track label Oct 18, 2018

@refack

This comment has been minimized.

Copy link
Member

commented Oct 18, 2018

I'm +1 for fast-tracking this

@Trott

This comment has been minimized.

Copy link
Member Author

commented Oct 19, 2018

That's one fast-track approval from @refack. If another Collaborator also feels this should be fast-tracked, please 👍 this comment or otherwise indicate so. Thanks!

@Trott

This comment has been minimized.

Copy link
Member Author

commented Oct 19, 2018

Trott added a commit to Trott/io.js that referenced this pull request Oct 19, 2018
tools: clarify commit message linting
Clarify in Travis results that the commit message linting is for the
commit message and not something else.

PR-URL: nodejs#23742
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
@Trott

This comment has been minimized.

Copy link
Member Author

commented Oct 19, 2018

Landed in 2cb2597

@Trott Trott closed this Oct 19, 2018

addaleax added a commit that referenced this pull request Oct 20, 2018
tools: clarify commit message linting
Clarify in Travis results that the commit message linting is for the
commit message and not something else.

PR-URL: #23742
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
jasnell added a commit that referenced this pull request Oct 21, 2018
tools: clarify commit message linting
Clarify in Travis results that the commit message linting is for the
commit message and not something else.

PR-URL: #23742
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
@richardlau richardlau referenced this pull request Oct 23, 2018
1 of 1 task complete
MylesBorins added a commit that referenced this pull request Oct 30, 2018
tools: clarify commit message linting
Clarify in Travis results that the commit message linting is for the
commit message and not something else.

PR-URL: #23742
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
MylesBorins added a commit that referenced this pull request Nov 26, 2018
tools: clarify commit message linting
Clarify in Travis results that the commit message linting is for the
commit message and not something else.

PR-URL: #23742
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
@codebytere codebytere referenced this pull request Nov 27, 2018
rvagg added a commit that referenced this pull request Nov 28, 2018
tools: clarify commit message linting
Clarify in Travis results that the commit message linting is for the
commit message and not something else.

PR-URL: #23742
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
rvagg added a commit that referenced this pull request Nov 28, 2018
tools: clarify commit message linting
Clarify in Travis results that the commit message linting is for the
commit message and not something else.

PR-URL: #23742
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
MylesBorins added a commit that referenced this pull request Nov 29, 2018
tools: clarify commit message linting
Clarify in Travis results that the commit message linting is for the
commit message and not something else.

PR-URL: #23742
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
@codebytere codebytere referenced this pull request Nov 29, 2018
@BethGriggs BethGriggs referenced this pull request Dec 4, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
7 participants
You can’t perform that action at this time.