Allow configurable label exclusion

Signed-off-by: Jonas Rittershofer <[email protected]>

Readme.md

@@ -1,13 +1,12 @@
 Use as:
 `npm run generate -- --version=3.3.0`
 
-CLI Options
+The following options can be given to the script either via CLI Argument or as a key value pair in a file named `config.json` in the repository root.
 - `ghtoken` - Token to access github. Necessary for large number of requests.
-- `repository` - including org and repository -> e.g. `nextcloud/forms`
+- `repository` - including owner and repository -> e.g. `nextcloud/forms`
 - `base` - Base-Branch, the PRs are merged to. Defaults to `main`
+- `excludeLabels` - Array of strings. PRs which contain at least one of the given labels will be excluded. Defaults to `["dependencies"]`. As CLI Argument these should be given as comma-separated list, e.g. `--excludeLabels=dependencies,translations`.
 - `out` - Output Filename. Defaults to `nc_changelog.md`
 - `releaseDate` - Date of the new release. Defaults to today's date.
 - `version` - Tag-Name of upcoming release.
 - `previousVersion` - Tag-Name of the previous release. Defaults to latest Github release.
-
-All these options are possible to store a default value in a file named `config.json` in the repository root. Such they dont have to be given on each execution.

index.js

@@ -9,6 +9,8 @@ import writeOut from './utils/writeOut.js'
 
 const runtimeConfig = createRuntimeConfig()
 
+if (!runtimeConfig.repository) throw 'No repository given! Aborting.'
+
 octoInit(runtimeConfig.ghtoken)
 
 if (!runtimeConfig.previousVersion) {

utils/checkPrUsable.js

@@ -1,4 +1,4 @@
-import findLabel from "./findLabel.js"
+import findLabels from "./findLabels.js"
 
 /**
  * Check if a fetched PR is usable for us.
@@ -13,9 +13,8 @@ function checkPrUsable (pr, runtimeConfig, oldestDate) {
 		return false
 	}
 
-	// Remove dependencies
-	if (findLabel(pr, 'dependencies')) {
-		// console.debug('Dependencies')
+	// Remove exclude labeled PRs
+	if (findLabels(pr, runtimeConfig.excludeLabels)) {
 		return false
 	}
 

utils/createMdContent.js

@@ -1,5 +1,5 @@
 import filterRemainder from "./filterRemainder.js"
-import findLabel from "./findLabel.js"
+import findLabels from "./findLabels.js"
 
 /**
  * Function to create the Markdown Content out of the given PRs
@@ -19,7 +19,7 @@ const createMdContent = function (runtimeConfig, pulls) {
 	content += `\n[Full Changelog](https://github.com/${runtimeConfig.repository}/compare/${runtimeConfig.previousVersion}...${runtimeConfig.version})\n`
 
 	// Add Enhancements
-	;({filtered, remainder} = filterRemainder(remainder, findLabel, ['enhancement'])) // Outer brackets  and preceding semicolon necessary for destructuring.
+	;({filtered, remainder} = filterRemainder(remainder, findLabels, [['enhancement']])) // Outer brackets  and preceding semicolon necessary for destructuring.
 	if (filtered.length) {
 		content += `\n### Enhancements\n`
 		filtered.forEach(pull => 
@@ -28,7 +28,7 @@ const createMdContent = function (runtimeConfig, pulls) {
 	}
 
 	// Add Bugs
-	;({filtered, remainder} = filterRemainder(remainder, findLabel, ['bug'])) // Outer brackets and preceding semicolon necessary for destructuring.
+	;({filtered, remainder} = filterRemainder(remainder, findLabels, [['bug']])) // Outer brackets and preceding semicolon necessary for destructuring.
 	if (filtered.length) {
 		content += `\n### Fixed\n`
 		filtered.forEach(pull => 

utils/createRuntimeConfig.js

@@ -38,6 +38,10 @@ function createRuntimeConfig() {
 		runtimeConfig.releaseDate = now.toLocaleDateString('sv')
 	}
 
+	// Read exclude labels
+	runtimeConfig.excludeLabels = processArgs.excludeLabels ? processArgs.excludeLabels.split(",") :
+		(configFile.excludeLabels ? configFile.excludeLabels : ['dependencies'])
+
 	// Read outFile
 	runtimeConfig.outFile = processArgs.out ? processArgs.out :
 		(configFile.out ? configFile.out : 'nc_changelog.md')

utils/findLabels.js

@@ -0,0 +1,13 @@
+/**
+ * Check if PR contains Labels
+ * @param {Object} pull Pull-Request Object to check
+ * @param {Array.<string>} labels Array of labels to check for
+ * @returns {Boolean} Label found
+ */
+const findLabels = function (pull, labels) {
+	return labels.some(searchL => { 
+		return pull.labels.some(l => l.name === searchL)
+	})
+}
+
+export default findLabels