- slightly improve filtering code

- format config / readme

README.md

@@ -191,7 +191,9 @@ This configuration is a `.json` file in the following format.
     "tag_resolver": {
       "method": "semver"
     },
-    "base_branches": []
+    "base_branches": [
+      "dev"
+    ]
 }
 ```
 

configs_test/configuration_base_branches_develop.json

@@ -2,7 +2,10 @@
   "categories": [
     {
       "title": "",
-            "labels": ["dev", "Bump"]
+      "labels": [
+        "dev",
+        "Bump"
+      ]
     }
   ],
   "ignore_labels": [],
@@ -15,5 +18,7 @@
       "on_property": "title"
     }
   ],
-    "base_branches": ["develop"]
+  "base_branches": [
+    "develop"
+  ]
 }

configs_test/configuration_base_branches_main.json

@@ -2,7 +2,10 @@
   "categories": [
     {
       "title": "",
-            "labels": ["dev", "Bump"]
+      "labels": [
+        "dev",
+        "Bump"
+      ]
     }
   ],
   "ignore_labels": [],
@@ -15,5 +18,7 @@
       "on_property": "title"
     }
   ],
-    "base_branches": ["main"]
+  "base_branches": [
+    "main"
+  ]
 }

src/releaseNotes.ts

@@ -128,11 +128,12 @@ export class ReleaseNotes {
       return commmit.sha
     })
 
-    // return only the pull requests associated with this release
-    return pullRequests.filter(pr => {
+    // retrieve base branches we allow
     const baseBranches = configuration.base_branches || DefaultConfiguration.base_branches
     const allBaseBranchesAllowed = baseBranches.length === 0
 
+    // return only the pull requests associated with this release
+    return pullRequests.filter(pr => {
       return releaseCommitHashes.includes(pr.mergeCommitSha)
         && (allBaseBranchesAllowed || baseBranches.includes(pr.baseBranch))
     })