Commit cdd4540
doc,tools: annotate broken links in actions workflow
Change format of logged messages when run on GitHub Actions (i.e.
when the `GITHUB_ACTIONS` environment variable is true) so that
broken links are highlighted inline in pull requests.
Signed-off-by: Richard Lau <riclau@uk.ibm.com>
PR-URL: #34810
Refs: #34787
Reviewed-By: Mary Marchini <oss@mmarchini.me>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>1 parent 7f0869f commit cdd4540
1 file changed
Lines changed: 3 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -50,7 +50,9 @@ function checkFile(path) { | |||
| 50 | 50 | const targetURL = new URL(node.url, base); | |
| 51 | 51 | if (targetURL.protocol === 'file:' && !fs.existsSync(targetURL)) { | |
| 52 | 52 | const { line, column } = node.position.start; | |
| 53 | - console.error(`Broken link at ${path}:${line}:${column} (${node.url})`); | ||
| 53 | + console.error((process.env.GITHUB_ACTIONS ? | ||
| 54 | + `::error file=${path},line=${line},col=${column}::` : '') + | ||
| 55 | + `Broken link at ${path}:${line}:${column} (${node.url})`); | ||
| 54 | 56 | process.exitCode = 1; | |
| 55 | 57 | } | |
| 56 | 58 | } | |
0 commit comments