honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

ci: improve error message when payload size check fails (#41116) 

Previously, when a payload size check failed, the error message prompted
the user to update the size limits using a CI-specific file path, which
was confusing (esp. for external contributors). See, for example,
https://circleci.com/gh/angular/angular/932733.

This commit improves the error message by printing the file path
relative to the repository root instead.

PR Close #41116
This commit is contained in:
George Kalpakas 2021-03-08 13:47:46 +02:00 committed by Andrew Kushnir
parent c1a93fcf32
commit 531f0bfb4a
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
scripts/ci/payload-size.js
View File

@ -10,6 +10,7 @@
// Imports // Imports
const fs = require('fs'); const fs = require('fs');
const path = require('path');
// Get branch and project name from command line arguments. // Get branch and project name from command line arguments.
const [, , limitFile, project, branch, commit] = process.argv; const [, , limitFile, project, branch, commit] = process.argv;
@ -68,8 +69,10 @@ for (const compressionType in limitSizes) {
successMessages.concat(failureMessages).forEach(message => console.error(message)); successMessages.concat(failureMessages).forEach(message => console.error(message));
if (failed) { if (failed) {
const projectRoot = path.resolve(__dirname, '../..');
const limitFileRelPath = path.relative(projectRoot, limitFile);
console.info( console.info(
`If this is a desired change, please update the size limits in file '${limitFile}'.`); `If this is a desired change, please update the size limits in file '${limitFileRelPath}'.`);
process.exit(1); process.exit(1);
} else { } else {
console.info(`Payload size check passed. All diffs are less than 1% or 500 bytes.`); console.info(`Payload size check passed. All diffs are less than 1% or 500 bytes.`);