build: annotate markdown lint failures in pull requests#32391
Uh oh!
There was an error while loading. Please reload this page.
Conversation
Add a problem matcher for output from remark-lint to our lint-md GitHub Actions CI workflow so that any markdown linter failures are annotated in the pull request in the web UI. Signed-off-by: Richard Lau <[email protected]>
nodejs-github-bot added the meta 
richardlau commented Mar 20, 2020
An example annotation: |
Uh oh!
There was an error while loading. Please reload this page.
Trott left a comment
Trott left a comment There was a problem hiding this comment.
I won't pretend to have looked at those regular expressions carefully, but rubber-stamp LGTM.
Uh oh!
There was an error while loading. Please reload this page.
gengjiawen left a comment
gengjiawen left a comment There was a problem hiding this comment.
Any thought on doc the regexp ?
mmarchini left a comment
mmarchini left a comment There was a problem hiding this comment.
RSLGTM (also love it, by far the simplest solution to annotate code I've seen).
One concern though: add-matcher doesn't seem to be documented (I would expect to see it here). Do you know if this is a stable API, or if there's any chance they'll pull it out in the near future?
richardlau commented Mar 21, 2020
There’s no mention of problem matchers or annotations at all on that page (or any other help page for GitHub actions). The two referenced links are to the actions toolkit (https://github.com/actions/toolkit) where it’s documented. As to the stability of that your guess is as good as mine. If this does stop working it’s not the end of the world to lose the annotations — we would be back to where we are now without this PR.
What are you looking for? The regexps are trying to extract from the output of our markdown linting into the fields detailed in the first referenced link. Sample output to parse: |
Add a problem matcher for output from remark-lint to our lint-md GitHub Actions CI workflow so that any markdown linter failures are annotated in the pull request in the web UI. Signed-off-by: Richard Lau <[email protected]> PR-URL: #32391 Refs: https://github.com/actions/toolkit/blob/master/docs/problem-matchers.md Refs: https://github.com/actions/toolkit/blob/master/docs/commands.md#problem-matchers Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Jiawen Geng <[email protected]> Reviewed-By: Matheus Marchini <[email protected]>
richardlau commented Mar 24, 2020
Landed in f467b9b. |
Add a problem matcher for output from remark-lint to our lint-md GitHub Actions CI workflow so that any markdown linter failures are annotated in the pull request in the web UI. Signed-off-by: Richard Lau <[email protected]> PR-URL: #32391 Refs: https://github.com/actions/toolkit/blob/master/docs/problem-matchers.md Refs: https://github.com/actions/toolkit/blob/master/docs/commands.md#problem-matchers Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Jiawen Geng <[email protected]> Reviewed-By: Matheus Marchini <[email protected]>
Add a problem matcher for output from remark-lint to our lint-md GitHub Actions CI workflow so that any markdown linter failures are annotated in the pull request in the web UI. Signed-off-by: Richard Lau <[email protected]> PR-URL: nodejs#32391 Refs: https://github.com/actions/toolkit/blob/master/docs/problem-matchers.md Refs: https://github.com/actions/toolkit/blob/master/docs/commands.md#problem-matchers Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Jiawen Geng <[email protected]> Reviewed-By: Matheus Marchini <[email protected]>
Add a problem matcher for output from remark-lint to our lint-md GitHub Actions CI workflow so that any markdown linter failures are annotated in the pull request in the web UI. Signed-off-by: Richard Lau <[email protected]> Backport-PR-URL: #32608 PR-URL: #32391 Refs: https://github.com/actions/toolkit/blob/master/docs/problem-matchers.md Refs: https://github.com/actions/toolkit/blob/master/docs/commands.md#problem-matchers Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Jiawen Geng <[email protected]> Reviewed-By: Matheus Marchini <[email protected]>
8 participants
Add a problem matcher for output from remark-lint to our lint-md GitHub
Actions CI workflow so that any markdown linter failures are annotated
in the pull request in the web UI.
Refs: https://github.com/actions/toolkit/blob/master/docs/problem-matchers.md
Refs: https://github.com/actions/toolkit/blob/master/docs/commands.md#problem-matchers
Checklist