tools: add script to lint first PR commit message by richardlau · Pull Request #24030 · nodejs/node

richardlau · 2018-11-02T04:07:23Z

Decouple first commit in pull request linting from Travis by using
the GitHub API to work out the first commit.

The shell script obtains the pull request number in one of the
following ways:

supplied on the command line (use this to test against any PR)
TRAVIS_PULL_REQUEST if set and != "false"
derived from the HEAD commit via the GitHub API

The GitHub API should be more consistent with the web UI in terms of finding
the first commit for a pull request.

This is an alternative to #23758 with the bonus that
you can run the script against any pull request number.

Checklist

commit message follows commit guidelines

nodejs-github-bot · 2018-11-02T04:07:24Z

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

richardlau · 2018-11-02T04:13:48Z

Examples:

Run locally, no pull request specified (script works out based on current HEAD commit):

-bash-4.2$ bash tools/lint-pr-commit-message.sh
Linting the first commit message for pull request 24030
according to the guidelines at https://goo.gl/p2fr5Q.
Commit message for 826115ee852b8aef3dd6e9578c8b0190605c0e98 is:
tools: add script to lint first PR commit message

Decouple first commit in pull request linting from Travis by using
the GitHub API to work out the first commit.

The shell script obtains the pull request number in one of the
following ways:
 1) supplied on the command line (use this to test against any PR)
 2) TRAVIS_PULL_REQUEST if set and != "false"
 3) derived from the HEAD commit via the GitHub API
  ✔  826115ee852b8aef3dd6e9578c8b0190605c0e98
     ✔  0:0      skipping fixes-url                        fixes-url
     ✔  0:0      blank line after title                    line-after-title
     ✔  0:0      line-lengths are valid                    line-length
     ✔  0:0      valid subsystems                          subsystem
     ✔  0:0      Title is formatted correctly.             title-format
     ✔  0:0      Title is <= 50 columns.                   title-length
-bash-4.2$

Checking a completely different PR:

-bash-4.2$ bash tools/lint-pr-commit-message.sh 23758
Linting the first commit message for pull request 23758
according to the guidelines at https://goo.gl/p2fr5Q.
Commit message for fa99a11b207932c6d02ccfc9e8308984ed0f1f76 is:
tools: add script to lint commit messages

This script attempts to guess the target upstream branch.
To manually specify, e.g. to target `canary-base`:
  TARGET_BRANCH=canary-base bash lint-commit-message.sh
  ✔  fa99a11b207932c6d02ccfc9e8308984ed0f1f76
     ✔  0:0      skipping fixes-url                        fixes-url
     ✔  0:0      blank line after title                    line-after-title
     ✔  0:0      line-lengths are valid                    line-length
     ✔  0:0      valid subsystems                          subsystem
     ✔  0:0      Title is formatted correctly.             title-format
     ✔  0:0      Title is <= 50 columns.                   title-length
-bash-4.2$

On Travis (for this PR), https://travis-ci.com/nodejs/node/jobs/155889224:

tools/lint-pr-commit-message.sh

Decouple first commit in pull request linting from Travis by using the GitHub API to work out the first commit. The shell script obtains the pull request number in one of the following ways: 1) supplied on the command line (use this to test against any PR) 2) derived from the HEAD commit via the GitHub API

richardlau · 2018-11-02T15:48:38Z

Moved the Travis specific stuff out of the script back into .travis.yml.

richardlau · 2018-11-02T15:57:45Z

Longer term we could teach core-validate-commit:

to take a PR argument and lint all the commits for that PR (as determined by GitHub's API)
to ignore "fixup!" and "squash!" commit messages

and then replace the shell script here with a direct call to npx -q core-validate-commit ....

Trott · 2018-11-04T07:14:52Z

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

Decouple first commit in pull request linting from Travis by using the GitHub API to work out the first commit. The shell script obtains the pull request number in one of the following ways: 1) supplied on the command line (use this to test against any PR) 2) derived from the HEAD commit via the GitHub API PR-URL: nodejs#24030 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

Trott · 2018-11-04T07:25:20Z

Landed in 7489ee8

addaleax · 2018-11-04T11:19:34Z

@Trott @richardlau This seems to have broken Travis CI for non-PR branches without TRAVIS_PULL_REQUEST?

Do not run any linting at all when `TRAVIS_PULL_REQUEST` is `false`. This would otherwise break Travis CI for `master` and release branches. Refs: nodejs#24030

Do not run any linting at all when `TRAVIS_PULL_REQUEST` is `false`. This would otherwise break Travis CI for `master` and release branches. Refs: nodejs#24030 PR-URL: nodejs#24076 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

Decouple first commit in pull request linting from Travis by using the GitHub API to work out the first commit. The shell script obtains the pull request number in one of the following ways: 1) supplied on the command line (use this to test against any PR) 2) derived from the HEAD commit via the GitHub API PR-URL: #24030 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

Do not run any linting at all when `TRAVIS_PULL_REQUEST` is `false`. This would otherwise break Travis CI for `master` and release branches. Refs: #24030 PR-URL: #24076 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

Decouple first commit in pull request linting from Travis by using the GitHub API to work out the first commit. The shell script obtains the pull request number in one of the following ways: 1) supplied on the command line (use this to test against any PR) 2) derived from the HEAD commit via the GitHub API PR-URL: #24030 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

Do not run any linting at all when `TRAVIS_PULL_REQUEST` is `false`. This would otherwise break Travis CI for `master` and release branches. Refs: #24030 PR-URL: #24076 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

Decouple first commit in pull request linting from Travis by using the GitHub API to work out the first commit. The shell script obtains the pull request number in one of the following ways: 1) supplied on the command line (use this to test against any PR) 2) derived from the HEAD commit via the GitHub API PR-URL: #24030 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

Do not run any linting at all when `TRAVIS_PULL_REQUEST` is `false`. This would otherwise break Travis CI for `master` and release branches. Refs: #24030 PR-URL: #24076 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

Decouple first commit in pull request linting from Travis by using the GitHub API to work out the first commit. The shell script obtains the pull request number in one of the following ways: 1) supplied on the command line (use this to test against any PR) 2) derived from the HEAD commit via the GitHub API PR-URL: #24030 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

Do not run any linting at all when `TRAVIS_PULL_REQUEST` is `false`. This would otherwise break Travis CI for `master` and release branches. Refs: #24030 PR-URL: #24076 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

nodejs-github-bot added the tools Issues and PRs related to the tools directory. label Nov 2, 2018

richardlau mentioned this pull request Nov 2, 2018

tools: add script to lint commit messages #23758

Closed

1 task

refack reviewed Nov 2, 2018

View reviewed changes

tools/lint-pr-commit-message.sh Outdated Show resolved Hide resolved

refack added build Issues and PRs related to build files or the CI. meta Issues and PRs related to the general management of the project. labels Nov 2, 2018

refack reviewed Nov 2, 2018

View reviewed changes

tools/lint-pr-commit-message.sh Outdated Show resolved Hide resolved

richardlau force-pushed the pr-commit-lint branch from 826115e to 38f2b1e Compare November 2, 2018 15:45

refack approved these changes Nov 2, 2018

View reviewed changes

Trott approved these changes Nov 4, 2018

View reviewed changes

Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Nov 4, 2018

Trott closed this Nov 4, 2018

addaleax mentioned this pull request Nov 4, 2018

build: do not lint on non-PR Travis builds #24076

Closed

2 tasks

richardlau deleted the pr-commit-lint branch November 5, 2018 00:43

richardlau mentioned this pull request Nov 6, 2018

Travis linter false-negatives for commit message checks #23737

Closed

BridgeAR mentioned this pull request Nov 14, 2018

Release proposal: v11.2 #24350

Merged

This was referenced Nov 15, 2018

2018-11-15 Version 11.2.0 (Current) @BridgeAR beevelop/docker-nodejs#232

Closed

2018-11-15 Version 11.2.0 (Current) @BridgeAR beevelop/docker-android-nodejs#249

Closed

codebytere added the land-on-v10.x label Nov 29, 2018

codebytere mentioned this pull request Nov 29, 2018

v10.14.2 proposal #24727

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

tools: add script to lint first PR commit message#24030

tools: add script to lint first PR commit message#24030
richardlau wants to merge 1 commit intonodejs:masterfrom
richardlau:pr-commit-lint

richardlau commented Nov 2, 2018

Uh oh!

nodejs-github-bot commented Nov 2, 2018

Uh oh!

richardlau commented Nov 2, 2018

Uh oh!

Uh oh!

Uh oh!

richardlau commented Nov 2, 2018

Uh oh!

richardlau commented Nov 2, 2018

Uh oh!

Trott commented Nov 4, 2018

Uh oh!

Trott commented Nov 4, 2018 •

edited

Loading

Uh oh!

addaleax commented Nov 4, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Uh oh!

Conversation

richardlau commented Nov 2, 2018

Checklist

Uh oh!

nodejs-github-bot commented Nov 2, 2018

Uh oh!

richardlau commented Nov 2, 2018

Uh oh!

Uh oh!

Uh oh!

richardlau commented Nov 2, 2018

Uh oh!

richardlau commented Nov 2, 2018

Uh oh!

Trott commented Nov 4, 2018

Uh oh!

Trott commented Nov 4, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

addaleax commented Nov 4, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Trott commented Nov 4, 2018 •

edited

Loading