Update pre-commit script error message (automation/check-doc.js)

Change-type: patch
This commit is contained in:
Paulo Castro 2020-05-15 21:36:47 +01:00
parent 11d5deef4c
commit 81269e92d5

View File

@ -58,12 +58,10 @@ async function checkBuildTimestamps() {
This probably means that \`npm run build\` or \`npm test\` have not been executed, This probably means that \`npm run build\` or \`npm test\` have not been executed,
and this error can be fixed by doing so. Running \`npm run build\` or \`npm test\` and this error can be fixed by doing so. Running \`npm run build\` or \`npm test\`
before commiting is currently a requirement (documented in the CONTRIBUTING.md before commiting is required in order to update the CLI markdown documentation
file) for three reasons: (in case any command-line options were updated, added or removed) and also to
1. To update the CLI markdown documentation (in case any command-line options catch Typescript type check errors sooner and reduce overall waiting time, given
were updated, added or removed). that the CI build/tests are currently rather lengthy.
2. To catch Typescript type check errors sooner and reduce overall waiting time,
given that balena-cli CI builds/tests are currently rather lengthy.
If you need/wish to bypass this check without running \`npm run build\`, run: If you need/wish to bypass this check without running \`npm run build\`, run:
npx touch -am "${docFile}" npx touch -am "${docFile}"