open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[editorial][CI] Ensure markdownlint has proper exit status (#210) 

Co-authored-by: Josh Suereth <joshuasuereth@google.com>
This commit is contained in:
Patrice Chalin 2023-07-27 09:21:07 -04:00 committed by GitHub
parent a5509c690a
commit 73408c933e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
gulpfile.js
View File

@ -4,8 +4,8 @@ const markdownlint = require("markdownlint");
const yaml = require("js-yaml"); const yaml = require("js-yaml");
const fs = require("fs"); const fs = require("fs");
let fileCount = 0, let numFilesProcessed = 0,
issueCount = 0; numFilesWithIssues = 0;
function markdownLintFile(file, encoding, callback) { function markdownLintFile(file, encoding, callback) {
const config = yaml.load(fs.readFileSync("./.markdownlint.yaml", "utf8")); const config = yaml.load(fs.readFileSync("./.markdownlint.yaml", "utf8"));
@ -33,9 +33,11 @@ function markdownLintFile(file, encoding, callback) {
.join("\n"); .join("\n");
if (resultString) { if (resultString) {
console.log(resultString); console.log(resultString);
issueCount++; numFilesWithIssues++;
// Don't report an error yet so that other files can be checked:
// callback(new Error('...'));
} }
fileCount++; numFilesProcessed++;
callback(null, file); callback(null, file);
}); });
} }
@ -47,11 +49,13 @@ function lintMarkdown() {
.src(markdownFiles) .src(markdownFiles)
.pipe(through2.obj(markdownLintFile)) .pipe(through2.obj(markdownLintFile))
.on("end", () => { .on("end", () => {
console.log( const fileOrFiles = "file" + (numFilesProcessed == 1 ? "" : "s");
`Processed ${fileCount} file${ const msg = `Processed ${numFilesProcessed} ${fileOrFiles}, ${numFilesWithIssues} had issues.`;
fileCount == 1 ? "" : "s" if (numFilesWithIssues > 0) {
}, ${issueCount} had issues.`, throw new Error(msg);
); } else {
console.log(msg);
}
}); });
} }