Merge pull request #1137 from mikepenz/feature/update_default_categories

Include `uncategorized` category in default categories

README.md

@@ -100,7 +100,7 @@ Below is a complete example showcasing how to define a build, which is executed
 - Build changelog, given the tag
 - Create release on GitHub - specifying body with constructed changelog
 
-> Note: PRs will only show up in the changelog if assigned one of the default label categories "feature", "fix" or "test"
+> Note: Pre v4 PRs will only show up in the changelog if assigned one of the default label categories "feature", "fix" or "test". Starting with v4 these PRs will be in the `Uncategorized` section. 
 
 <details><summary><b>Example</b></summary>
 <p>

__tests__/releaseNotesBuilder.test.ts

@@ -144,6 +144,7 @@ it('Should fill `template` placeholders', async () => {
 
 it('Should fill `template` placeholders, ignore', async () => {
   const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs_test/configuration_empty_all_placeholders.json'))
+  configuration.categories.pop() // drop `uncategorized` category
   const releaseNotesBuilder = new ReleaseNotesBuilder(
     null,
     null,

__tests__/releaseNotesBuilderPull.test.ts

@@ -133,6 +133,7 @@ nhoelzl
 
 it('Should match ordered ASC', async () => {
   const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs_test/configuration_asc.json'))
+  configuration.categories.pop() // drop `uncategorized` category
   const options = {
     owner: 'mikepenz',
     repo: 'release-changelog-builder-action',
@@ -155,6 +156,7 @@ it('Should match ordered ASC', async () => {
 
 it('Should match ordered DESC', async () => {
   const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs_test/configuration_desc.json'))
+  configuration.categories.pop() // drop `uncategorized` category
   const options = {
     owner: 'mikepenz',
     repo: 'release-changelog-builder-action',

__tests__/transform.test.ts

@@ -376,6 +376,7 @@ it('Match multiple labels exhaustive for category', async () => {
 
 it('Deduplicate duplicated PRs', async () => {
   const customConfig = Object.assign({}, DefaultConfiguration)
+  customConfig.categories.pop() // drop `uncategorized` category
   customConfig.duplicate_filter = {
     pattern: '\\[ABC-....\\]',
     on_property: 'title',
@@ -388,6 +389,7 @@ it('Deduplicate duplicated PRs', async () => {
 
 it('Deduplicate duplicated PRs DESC', async () => {
   const customConfig = Object.assign({}, DefaultConfiguration)
+  customConfig.categories.pop() // drop `uncategorized` category
   customConfig.sort = 'DESC'
   customConfig.duplicate_filter = {
     pattern: '\\[ABC-....\\]',

dist/licenses.txt

@@ -541,9 +541,6 @@ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
 IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 
-github-pr-collector
-Apache 2.0
-
 has-flag
 MIT
 MIT License
@@ -700,6 +697,9 @@ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
 IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 
+pr-collector
+Apache 2.0
+
 semver
 ISC
 The ISC License

package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-changelog-builder-action",
-  "version": "v3.0.0",
+  "version": "v4.0.0",
   "private": true,
   "description": "A GitHub action that builds your release notes / changelog fast, easy and exactly the way you want.",
   "main": "lib/main.js",

src/configuration.ts

@@ -85,6 +85,10 @@ export const DefaultConfiguration: Configuration = {
     {
       title: '## 🧪 Tests',
       labels: ['test']
+    },
+    {
+      title: '## 📦 Uncategorized',
+      labels: []
     }
   ], // the categories to support for the ordering
   ignore_labels: ['ignore'], // list of lables being ignored from the changelog