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.

Sign up for GitHub

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

Jump to bottom

tools: clarify commit message linting #23742

Closed
wants to merge 2 commits into from
Closed

tools: clarify commit message linting #23742

wants to merge 2 commits into from

Conversation

Trott
Copy link
Member

@Trott Trott 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

@nodejs-github-bot
Copy link
Collaborator

@Trott build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/1287/pipeline

@Trott Trott mentioned this pull request Oct 18, 2018
Merged
3 tasks
refack
refack reviewed Oct 18, 2018
View reviewed changes
.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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member Author

Trott commented Oct 18, 2018

Here's what the updated friendly message looks like:

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

@refack
Copy link
Contributor

refack commented Oct 18, 2018 •
edited
Loading

Could you add:

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

@refack refack added test Issues and PRs related to the tests. meta Issues and PRs related to the general management of the project. labels Oct 18, 2018
@Trott
tools: clarify commit message linting
1b7dfea 
Clarify in Travis results that the commit message linting is for the
commit message and not something else.
@richardlau
Copy link
Member

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
Copy link
Contributor

refack 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
Copy link
Member Author

Trott 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.... 😱

@Trott
Copy link
Member Author

Trott 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
Copy link
Member Author

Trott commented Oct 18, 2018

Here's what it looks like now:

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

@refack
Copy link
Contributor

refack 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 PRs that do not need to wait for 48 hours to land. label Oct 18, 2018
@refack
Copy link
Contributor

refack commented Oct 18, 2018

I'm +1 for fast-tracking this

@Trott
Copy link
Member Author

Trott 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
Copy link
Member Author

Trott commented Oct 19, 2018

Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/1294/

Trott added a commit to Trott/io.js that referenced this pull request Oct 19, 2018
@Trott
tools: clarify commit message linting
2cb2597 
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
Copy link
Member Author

Trott commented Oct 19, 2018

Landed in 2cb2597

@Trott Trott closed this Oct 19, 2018
addaleax pushed a commit that referenced this pull request Oct 20, 2018
@Trott @addaleax
tools: clarify commit message linting
63c27ce 
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 pushed a commit that referenced this pull request Oct 21, 2018
@Trott @jasnell
tools: clarify commit message linting
cdd58e6 
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 mentioned this pull request Oct 23, 2018
Closed
1 task
MylesBorins pushed a commit that referenced this pull request Oct 30, 2018
@Trott @MylesBorins
tools: clarify commit message linting
703f40a 
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 pushed a commit that referenced this pull request Nov 26, 2018
@Trott @MylesBorins
tools: clarify commit message linting
c88d962 
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 mentioned this pull request Nov 27, 2018
Closed
rvagg pushed a commit that referenced this pull request Nov 28, 2018
@Trott @rvagg
tools: clarify commit message linting
02209c5 
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 pushed a commit that referenced this pull request Nov 28, 2018
@Trott @rvagg
tools: clarify commit message linting
fe56cad 
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 pushed a commit that referenced this pull request Nov 29, 2018
@Trott @MylesBorins
tools: clarify commit message linting
7670bc5 
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 mentioned this pull request Nov 29, 2018
Merged
@BethGriggs BethGriggs mentioned this pull request Dec 4, 2018
Merged
This was referenced Dec 18, 2018
Closed
Closed
Closed
Closed
Closed
@Trott Trott deleted the commitments branch January 13, 2022 22:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vdeturckheim vdeturckheim vdeturckheim approved these changes

@richardlau richardlau richardlau approved these changes

@thefourtheye thefourtheye thefourtheye approved these changes

@refack refack refack approved these changes

Assignees
No one assigned
Labels
fast-track PRs that do not need to wait for 48 hours to land. meta Issues and PRs related to the general management of the project. test Issues and PRs related to the tests.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@Trott @nodejs-github-bot @refack @richardlau @thefourtheye @vdeturckheim @MylesBorins