mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
18 lines
658 B
JavaScript
18 lines
658 B
JavaScript
|
/**
|
||
|
|
* Check if MR Description has accurate description".
|
||
|
|
*
|
||
|
|
* @dangerjs WARN
|
||
|
|
*/
|
||
|
|
module.exports = function () {
|
||
|
|
const mrDescription = danger.gitlab.mr.description;
|
||
|
|
const descriptionChunk = mrDescription.match(/^([^#]*)/)[1].trim(); // Extract all text before the first section header (i.e., the text before the "## Release notes")
|
||
|
|
|
||
|
|
const shortMrDescriptionThreshold = 50; // Description is considered too short below this number of characters
|
||
|
|
|
||
|
|
if (descriptionChunk.length < shortMrDescriptionThreshold) {
|
||
|
|
return warn(
|
||
|
|
"The MR description looks very brief, please check if more details can be added."
|
||
|
|
);
|
||
|
|
}
|
||
|
|
};
|