feat: point to guidelines on failure in TAP output #95

richardlau · 2022-02-25T11:38:07Z

If commit linting fails, include the URL to the commit message
guidelines in the TAP output.

This will output, e.g.

# 86c832519452f74a1c4a701ec086509847d2485f
ok 1 co-authored-by-is-trailer: no Co-authored-by metadata
ok 2 fixes-url: skipping fixes-url # SKIP
ok 3 line-after-title: blank line after title
ok 4 line-length: line-lengths are valid
not ok 5 subsystem: Invalid subsystem: "feat" (feat: point to guidelines on failure in TAP output)
  ---
    {
      found: 'feat: point to guidelines on failure in TAP output',
      compare: 'indexOf() !== -1',
      wanted: [
        'benchmark',      'build',    'bootstrap',   'cli',
        'deps',           'doc',      'errors',      'etw',
        'esm',            'gyp',      'inspector',   'lib',
        'loader',         'meta',     'msi',         'node',
        'node-api',       'perfctr',  'policy',      'src',
        'test',           'tools',    'typings',     'wasm',
        'win',            'assert',   'async_hooks', 'buffer',
        'child_process',  'cluster',  'console',     'constants',
        'crypto',         'debugger', 'dgram',       'dns',
        'domain',         'events',   'fs',          'http',
        'http2',          'https',    'inspector',   'module',
        'net',            'os',       'path',        'perf_hooks',
        'process',        'punycode', 'querystring', 'quic',
        'readline',       'repl',     'report',      'stream',
        'string_decoder', 'sys',      'timers',      'tls',
        'trace_events',   'tty',      'url',         'util',
        'v8',             'vm',       'wasi',        'worker',
        'zlib'
      ],
      at: { line: 0, column: 0, body: undefined }
    }
  ...
ok 6 title-format: Title is formatted correctly.
ok 7 title-length: Title is <= 50 columns.

0..7
# tests 7
# pass  5
# fail  1
# Please review the commit message guidelines:
# https://github.com/nodejs/node/blob/HEAD/doc/contributing/pull-requests.md#commit-message-guidelines

When clicking on "Details" for a failed GitHub actions check the URL has ?check_suite_focus=true appended, e.g. https://github.com/nodejs/node/runs/4741156729?check_suite_focus=true, which automatically expands the failing part of the workflow so this additional output will be immediately above the Error: Process completed with exit code 123. in the expanded output.

codecov · 2022-02-25T11:38:59Z

Codecov Report

Merging #95 (72d2517) into main (69435db) will increase coverage by 18.22%.
The diff coverage is 100.00%.

@@             Coverage Diff             @@
##             main      #95       +/-   ##
===========================================
+ Coverage   75.65%   93.88%   +18.22%     
===========================================
  Files          19       19               
  Lines         456      458        +2     
===========================================
+ Hits          345      430       +85     
+ Misses        111       28       -83

Impacted Files	Coverage Δ
lib/tap.js	`93.22% <100.00%> (+87.95%)`	⬆️
bin/cmd.js	`90.69% <0.00%> (+23.25%)`	⬆️
lib/format-tap.js	`66.66% <0.00%> (+61.90%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 69435db...72d2517. Read the comment docs.

If commit linting fails, include the URL to the commit message guidelines in the TAP output.

richardlau · 2022-02-25T12:34:45Z

I've added a test to cover the new lines.

The shortened link to the commit message guidelines no longer works after they were moved from `docs/guides` to `docs/contributing`. Now that `core-validate-commit` outputs an error message pointing to the full URL of the commit message guidelines on failure we no longer need to include the URL (shortened or otherwise) in the workflow title. PR-URL: #42168 Refs: nodejs/core-validate-commit#95 Refs: #41697 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Mestery <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: Darshan Sen <[email protected]>

The shortened link to the commit message guidelines no longer works after they were moved from `docs/guides` to `docs/contributing`. Now that `core-validate-commit` outputs an error message pointing to the full URL of the commit message guidelines on failure we no longer need to include the URL (shortened or otherwise) in the workflow title. PR-URL: nodejs#42168 Refs: nodejs/core-validate-commit#95 Refs: nodejs#41697 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Mestery <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: Darshan Sen <[email protected]>

The shortened link to the commit message guidelines no longer works after they were moved from `docs/guides` to `docs/contributing`. Now that `core-validate-commit` outputs an error message pointing to the full URL of the commit message guidelines on failure we no longer need to include the URL (shortened or otherwise) in the workflow title. PR-URL: #42168 Refs: nodejs/core-validate-commit#95 Refs: #41697 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Mestery <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: Darshan Sen <[email protected]>

The shortened link to the commit message guidelines no longer works after they were moved from `docs/guides` to `docs/contributing`. Now that `core-validate-commit` outputs an error message pointing to the full URL of the commit message guidelines on failure we no longer need to include the URL (shortened or otherwise) in the workflow title. PR-URL: nodejs#42168 Refs: nodejs/core-validate-commit#95 Refs: nodejs#41697 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Mestery <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: Darshan Sen <[email protected]>

richardlau mentioned this pull request Feb 25, 2022

Shortened URL for the commit message guidelines no longer works and change of URL shortening service nodejs/node#41697

Closed

targos approved these changes Feb 25, 2022

View reviewed changes

feat: point to guidelines on failure in TAP output

72d2517

If commit linting fails, include the URL to the commit message guidelines in the TAP output.

richardlau force-pushed the with-contrib-url branch from 86c8325 to 72d2517 Compare February 25, 2022 12:33

evanlucas approved these changes Feb 25, 2022

View reviewed changes

RaisinTen approved these changes Feb 25, 2022

View reviewed changes

richardlau merged commit 0e137d0 into nodejs:main Mar 1, 2022

richardlau deleted the with-contrib-url branch March 1, 2022 12:14

richardlau mentioned this pull request Mar 1, 2022

build: drop shortened URL from lint-commit-message nodejs/node#42168

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: point to guidelines on failure in TAP output #95

feat: point to guidelines on failure in TAP output #95

richardlau commented Feb 25, 2022

codecov bot commented Feb 25, 2022 •

edited

Loading

richardlau commented Feb 25, 2022

feat: point to guidelines on failure in TAP output #95

feat: point to guidelines on failure in TAP output #95

Conversation

richardlau commented Feb 25, 2022

codecov bot commented Feb 25, 2022 • edited Loading

Codecov Report

richardlau commented Feb 25, 2022

codecov bot commented Feb 25, 2022 •

edited

Loading