mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
7c58a38e88
Break DangerJS checks to modules Improove "Release notes" section detection Change check for size MR to async/await syntax Update check for MR title - exact match WIP and DRAFT Add check for incorrect format closing Jira link Update check WIP in MR title
27 lines
1020 B
JavaScript
27 lines
1020 B
JavaScript
/**
|
|
* Check commit message are descriptive enough (longer that 10 characters)
|
|
*
|
|
* #TODO: this simple logic will be improved in future MRs - Jira IDF-6856.
|
|
*
|
|
* @dangerjs WARN
|
|
*/
|
|
module.exports = function () {
|
|
const shortCommitMessageThreshold = 10; // commit message is considered too short below this number of characters
|
|
const mrCommit = danger.gitlab.commits;
|
|
|
|
let shortCommitMessages = [];
|
|
for (let i = 0; i < mrCommit.length; i++) {
|
|
const commitMessage = mrCommit[i].message;
|
|
|
|
if (commitMessage.length < shortCommitMessageThreshold) {
|
|
shortCommitMessages.push(`- commit message: ${commitMessage}`);
|
|
}
|
|
}
|
|
|
|
if (shortCommitMessages.length) {
|
|
warn(`Some of your commit messages may not be sufficiently descriptive (are shorter than ${shortCommitMessageThreshold} characters):
|
|
\n${shortCommitMessages.join("")}
|
|
\nYou might consider squashing commits (simplifying branch history) or updating those short commit messages.`);
|
|
}
|
|
};
|