Merge pull request #104 from logchange/69-new-entry-type-dependency-u…

…pdate added dependency_update changelog entry type
logchange · Apr 25, 2023 · b3aa6df · b3aa6df
2 parents 3f44d39 + 518545a
commit b3aa6df
Show file tree

Hide file tree

Showing 85 changed files with 140 additions and 101 deletions.
diff --git a/README.md b/README.md
@@ -56,7 +56,7 @@ You can choose between two options:
         <plugin>
             <groupId>dev.logchange</groupId>
             <artifactId>logchange-maven-plugin</artifactId>
-            <version>0.8.0</version>
+            <version>1.0.0</version>
             <inherited>false</inherited> <!-- For multi module project -->
         </plugin>
     </plugins>
@@ -128,7 +128,7 @@ issues:
 links: # links to different project's issue or external systems, like jira or redmine
   - name: TASK_NUMBER
     url: https://www.google.pl
-type: fixed # [added/changed/deprecated/removed/fixed/security/other]
+type: fixed # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 important_notes:
   - Update style.css on server during instalation 1
 configurations: # information about changes in available application configuration
@@ -174,28 +174,29 @@ Copy following section as default config.
 # Visit https://github.com/logchange/logchange and leave a star 🌟 
 # More info about configuration you can find https://github.com/logchange/logchange#configuration 
 changelog:
-    heading: Some information that will be display in the top of CHANGELOG.md
-    labels:
-        unreleased: unreleased
-        important_notes: Important notes
-        types:
-            added: Added
-            changed: Changed
-            deprecated: Deprecated
-            removed: Removed
-            fixed: Fixed
-            security: Security
-            other: Security
-            number_of_changes:
-                singular: change
-                plural: changes
-        configuration:
-            heading: Configuration changes
-            type: Type
-            actions:
-                add: Added
-                delete: Deleted
-                update: Updated
+  heading: Some information that will be display in the top of CHANGELOG.md
+  labels:
+    unreleased: unreleased
+    important_notes: Important notes
+    types:
+      added: Added
+      changed: Changed
+      deprecated: Deprecated
+      removed: Removed
+      fixed: Fixed
+      security: Security
+      dependency_update: Dependency update
+      other: Other
+      number_of_changes:
+        singular: change
+        plural: changes
+    configuration:
+      heading: Configuration changes
+      type: Type
+      actions:
+        add: Added
+        delete: Deleted
+        update: Updated
             with_default_value: with default value
             description: Description
 ```

diff --git a/changelog/logchange-config.yml b/changelog/logchange-config.yml
@@ -12,6 +12,7 @@ changelog:
       removed: Removed
       fixed: Fixed
       security: Security
+      dependency_update: Dependency updates
       other: Security
       number_of_changes:
         singular: change

diff --git a/changelog/unreleased/0001-dependency-update-entry-type.yml b/changelog/unreleased/0001-dependency-update-entry-type.yml
@@ -0,0 +1,7 @@
+title: Added `dependency_update` changelog entry type.
+authors:
+  - name: Peter
+    nick: marwin1991
+    url: https://github.com/marwin1991
+type: added # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
+
diff --git a/changelog/v0.1.0/0001-generateing-changelog.yml b/changelog/v0.1.0/0001-generateing-changelog.yml
@@ -3,5 +3,5 @@ authors:
   - name: Peter
     nick: marwin1991
     url: https://github.com/marwin1991
-type: added # [added/changed/deprecated/removed/fixed/security/other]
+type: added # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 
diff --git a/changelog/v0.2.0/0001-example-project.yml b/changelog/v0.2.0/0001-example-project.yml
@@ -3,5 +3,5 @@ authors:
   - name: Peter
     nick: marwin1991
     url: https://github.com/marwin1991
-type: added # [added/changed/deprecated/removed/fixed/security/other]
+type: added # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 
diff --git a/changelog/v0.2.0/0002-init-project-command.yml b/changelog/v0.2.0/0002-init-project-command.yml
@@ -2,7 +2,7 @@ title: Added maven command to initialize project with changelog/unreleased direc
 authors:
   nick: Glukasze
   url: https://github.com/Glukasze
-type: added # [added/changed/deprecated/removed/fixed/security/other]
+type: added # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 merge_requests:
   - 3
 
diff --git a/changelog/v0.2.0/0003-init-project-command.yml b/changelog/v0.2.0/0003-init-project-command.yml
@@ -3,5 +3,5 @@ authors:
   - name: Peter
     nick: marwin1991
     url: https://github.com/marwin1991
-type: added # [added/changed/deprecated/removed/fixed/security/other]
+type: added # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 
diff --git a/changelog/v0.3.0/0001-generating-version-summary.yml b/changelog/v0.3.0/0001-generating-version-summary.yml
@@ -2,5 +2,5 @@ title: Added generation of version-summary.md in every version's directory durin
 authors:
   - nick: marwin1991
     url: https://github.com/marwin1991
-type: added # [added/changed/deprecated/removed/fixed/security/other]
+type: added # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 
diff --git a/changelog/v0.4.0/0001-configuration-keyword-change.yml b/changelog/v0.4.0/0001-configuration-keyword-change.yml
@@ -3,5 +3,5 @@ authors:
   - name: Peter
     nick: marwin1991
     url: https://github.com/marwin1991
-type: changed # [added/changed/deprecated/removed/fixed/security/other]
+type: changed # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 
diff --git a/changelog/v0.4.0/0002-disabled-auto-format.yml b/changelog/v0.4.0/0002-disabled-auto-format.yml
@@ -3,5 +3,5 @@ authors:
   - name: Peter
     nick: marwin1991
     url: https://github.com/marwin1991
-type: added # [added/changed/deprecated/removed/fixed/security/other]
+type: added # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 
diff --git a/changelog/v0.4.0/0003-noinspection.yml b/changelog/v0.4.0/0003-noinspection.yml
@@ -3,5 +3,5 @@ authors:
   - name: Peter
     nick: marwin1991
     url: https://github.com/marwin1991
-type: added # [added/changed/deprecated/removed/fixed/security/other]
+type: added # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 
diff --git a/changelog/v0.4.0/0004-rename-mergerequest-property.yml b/changelog/v0.4.0/0004-rename-mergerequest-property.yml
@@ -3,5 +3,5 @@ authors:
   - name: Peter
     nick: marwin1991
     url: https://github.com/marwin1991
-type: changed # [added/changed/deprecated/removed/fixed/security/other]
+type: changed # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 
diff --git a/changelog/v0.4.0/0005-migrated-project.yml b/changelog/v0.4.0/0005-migrated-project.yml
@@ -3,5 +3,5 @@ authors:
   - name: Peter
     nick: marwin1991
     url: https://github.com/marwin1991
-type: changed # [added/changed/deprecated/removed/fixed/security/other]
+type: changed # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 
diff --git a/changelog/v0.4.0/0006-add-entry.yml b/changelog/v0.4.0/0006-add-entry.yml
@@ -3,5 +3,5 @@ authors:
   - name: Peter
     nick: marwin1991
     url: https://github.com/marwin1991
-type: added # [added/changed/deprecated/removed/fixed/security/other]
+type: added # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 
diff --git a/changelog/v0.5.0/0001-release-adjustments.yml b/changelog/v0.5.0/0001-release-adjustments.yml
@@ -3,5 +3,5 @@ authors:
   - name: Peter
     nick: marwin1991
     url: https://github.com/marwin1991
-type: fixed # [added/changed/deprecated/removed/fixed/security/other]
+type: fixed # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 
diff --git a/changelog/v0.5.0/0002-readded-generating-version-summary.yml b/changelog/v0.5.0/0002-readded-generating-version-summary.yml
@@ -2,5 +2,5 @@ title: Readded generation of version-summary.md in every version's directory dur
 authors:
   - nick: marwin1991
     url: https://github.com/marwin1991
-type: added # [added/changed/deprecated/removed/fixed/security/other]
+type: added # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 
diff --git a/changelog/v0.6.0/0001-other-entry-type.yml b/changelog/v0.6.0/0001-other-entry-type.yml
@@ -3,5 +3,5 @@ authors:
   - name: Peter
     nick: marwin1991
     url: https://github.com/marwin1991
-type: fixed # [added/changed/deprecated/removed/fixed/security/other]
+type: fixed # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 
diff --git a/changelog/v0.6.0/0002-conf-description-space.yml b/changelog/v0.6.0/0002-conf-description-space.yml
@@ -3,5 +3,5 @@ authors:
   - name: Peter
     nick: marwin1991
     url: https://github.com/marwin1991
-type: fixed # [added/changed/deprecated/removed/fixed/security/other]
+type: fixed # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 
diff --git a/changelog/v0.6.0/0003-config-labels.yml b/changelog/v0.6.0/0003-config-labels.yml
@@ -3,5 +3,5 @@ authors:
   - name: Peter
     nick: marwin1991
     url: https://github.com/marwin1991
-type: added # [added/changed/deprecated/removed/fixed/security/other]
+type: added # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 
diff --git a/changelog/v0.6.0/0003-encoding-fix.yml b/changelog/v0.6.0/0003-encoding-fix.yml
@@ -3,5 +3,5 @@ authors:
   - name: Peter
     nick: marwin1991
     url: https://github.com/marwin1991
-type: fixed # [added/changed/deprecated/removed/fixed/security/other]
+type: fixed # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 
diff --git a/changelog/v0.6.1/0001-generateing-changelog.yml b/changelog/v0.6.1/0001-generateing-changelog.yml
@@ -3,7 +3,7 @@ authors:
   - name: Peter
     nick: marwin1991
     url: https://github.com/marwin1991
-type: fixed # [added/changed/deprecated/removed/fixed/security/other]
+type: fixed # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 issues:
   - 28
 merge_requests:

diff --git a/changelog/v0.7.0/0001-create-config-during-init.yml b/changelog/v0.7.0/0001-create-config-during-init.yml
@@ -3,7 +3,7 @@ authors:
   - name: Peter
     nick: marwin1991
     url: https://github.com/marwin1991
-type: changed # [added/changed/deprecated/removed/fixed/security/other]
+type: changed # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 issues:
   - 26
 merge_requests:

diff --git a/changelog/v0.7.0/0002-fix-release-ignoring-config.yml b/changelog/v0.7.0/0002-fix-release-ignoring-config.yml
@@ -3,7 +3,7 @@ authors:
   - name: Peter
     nick: marwin1991
     url: https://github.com/marwin1991
-type: fixed # [added/changed/deprecated/removed/fixed/security/other]
+type: fixed # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 issues:
   - 36
 merge_requests:

diff --git a/changelog/v0.7.0/0003-fix-release-version-name.yml b/changelog/v0.7.0/0003-fix-release-version-name.yml
@@ -3,7 +3,7 @@ authors:
   - name: Peter
     nick: marwin1991
     url: https://github.com/marwin1991
-type: fixed # [added/changed/deprecated/removed/fixed/security/other]
+type: fixed # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 issues:
   - 35
 merge_requests:

diff --git a/changelog/v0.7.0/0004-added-info-with-link-to-generated-entry.yml b/changelog/v0.7.0/0004-added-info-with-link-to-generated-entry.yml
@@ -6,7 +6,7 @@ authors:
   - name: Peter
     nick: marwin1991
     url: https://github.com/marwin1991
-type: added # [added/changed/deprecated/removed/fixed/security/other]
+type: added # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 issues:
   - 33
 merge_requests:

diff --git a/changelog/v0.7.0/0005-added-info-to-changelog-to-not-modify.yml b/changelog/v0.7.0/0005-added-info-to-changelog-to-not-modify.yml
@@ -6,7 +6,7 @@ authors:
   - name: Peter
     nick: marwin1991
     url: https://github.com/marwin1991
-type: added # [added/changed/deprecated/removed/fixed/security/other]
+type: added # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 issues:
   - 32
 merge_requests:

diff --git a/changelog/v0.8.0/0054-typo.yml b/changelog/v0.8.0/0054-typo.yml
@@ -3,7 +3,7 @@ authors:
   - name: Peter
     nick: marwin1991
     url: https://github.com/marwin1991
-type: fixed # [added/changed/deprecated/removed/fixed/security/other]
+type: fixed # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 issues:
   - 54
 merge_requests:

diff --git a/changelog/v0.8.0/0064-duplicated-config-entries.yml b/changelog/v0.8.0/0064-duplicated-config-entries.yml
@@ -3,7 +3,7 @@ authors:
   - name: Peter
     nick: marwin1991
     url: https://github.com/marwin1991
-type: fixed # [added/changed/deprecated/removed/fixed/security/other]
+type: fixed # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 issues:
   - 64
 merge_requests:

diff --git a/changelog/v0.8.0/0073-heading-from-config.yml b/changelog/v0.8.0/0073-heading-from-config.yml
@@ -3,6 +3,6 @@ authors:
   - name: Peter
     nick: marwin1991
     url: https://github.com/marwin1991
-type: changed # [added/changed/deprecated/removed/fixed/security/other]
+type: changed # [added/changed/deprecated/removed/fixed/security/dependency_update/other]
 merge_requests:
   - 73
diff --git a/logchange-core/pom.xml b/logchange-core/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <groupId>dev.logchange</groupId>
         <artifactId>logchange</artifactId>
-        <version>0.9.0-SNAPSHOT</version>
+        <version>1.0.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>logchange-core</artifactId>

diff --git a/...ore/src/main/java/dev/logchange/core/domain/changelog/model/entry/ChangelogEntryType.java b/...ore/src/main/java/dev/logchange/core/domain/changelog/model/entry/ChangelogEntryType.java
@@ -13,7 +13,8 @@ public enum ChangelogEntryType {
     REMOVED("removed", 4),
     FIXED("fixed", 5),
     SECURITY("security", 6),
-    OTHER("other", 7);
+    DEPENDENCY_UPDATE("dependency_update", 7),
+    OTHER("other", 8);
 
 
     @Deprecated

diff --git a/logchange-core/src/main/java/dev/logchange/core/domain/config/model/labels/TypesLabels.java b/logchange-core/src/main/java/dev/logchange/core/domain/config/model/labels/TypesLabels.java
@@ -17,6 +17,8 @@ public class TypesLabels {
     public static final String DEFAULT_REMOVED_LABEL = "Removed";
     public static final String DEFAULT_FIXED_LABEL = "Fixed";
     public static final String DEFAULT_SECURITY_LABEL = "Security";
+
+    public static final String DEFAULT_DEPENDENCY_UPDATE_LABEL = "Dependency updates";
     public static final String DEFAULT_OTHER_LABEL = "Other";
 
     public static final TypesLabels EMPTY = TypesLabels.builder()
@@ -29,6 +31,7 @@ public class TypesLabels {
     private String removed;
     private String fixed;
     private String security;
+    private String dependencyUpdate;
     private String other;
 
     @Getter
@@ -48,6 +51,8 @@ public String getType(ChangelogEntryType type) {
                 return defaultIfBlank(fixed, DEFAULT_FIXED_LABEL);
             case SECURITY:
                 return defaultIfBlank(security, DEFAULT_SECURITY_LABEL);
+            case DEPENDENCY_UPDATE:
+                return defaultIfBlank(dependencyUpdate, DEFAULT_DEPENDENCY_UPDATE_LABEL);
             case OTHER:
                 return defaultIfBlank(other, DEFAULT_OTHER_LABEL);
             default:

diff --git a/...re/src/main/java/dev/logchange/core/format/yml/changelog/entry/YMLChangelogEntryType.java b/...re/src/main/java/dev/logchange/core/format/yml/changelog/entry/YMLChangelogEntryType.java
@@ -14,7 +14,7 @@ public enum YMLChangelogEntryType {
     REMOVED("removed"),
     FIXED("fixed"),
     SECURITY("security"),
-
+    DEPENDENCY_UPDATE("dependency_update"),
     OTHER("other");
 
     private final String type;
@@ -33,6 +33,8 @@ static YMLChangelogEntryType of(ChangelogEntryType type) {
                 return YMLChangelogEntryType.FIXED;
             case SECURITY:
                 return YMLChangelogEntryType.SECURITY;
+            case DEPENDENCY_UPDATE:
+                return YMLChangelogEntryType.DEPENDENCY_UPDATE;
             case OTHER:
                 return YMLChangelogEntryType.OTHER;
             default:
@@ -54,6 +56,8 @@ ChangelogEntryType to() {
                 return ChangelogEntryType.FIXED;
             case SECURITY:
                 return ChangelogEntryType.SECURITY;
+            case DEPENDENCY_UPDATE:
+                return ChangelogEntryType.DEPENDENCY_UPDATE;
             case OTHER:
                 return ChangelogEntryType.OTHER;
             default:

diff --git a/logchange-core/src/main/java/dev/logchange/core/format/yml/config/labels/YMLTypesLabels.java b/logchange-core/src/main/java/dev/logchange/core/format/yml/config/labels/YMLTypesLabels.java
@@ -33,7 +33,10 @@ public class YMLTypesLabels {
     @YamlProperty(key = "security", order = -6)
     public String security;
 
-    @YamlProperty(key = "other", order = -7)
+    @YamlProperty(key = "dependency_update", order = -7)
+    public String dependencyUpdate;
+
+    @YamlProperty(key = "other", order = -8)
     public String other;
 
     @YamlProperty(key = "number_of_changes", order = -8)
@@ -47,6 +50,7 @@ public static YMLTypesLabels of(TypesLabels types) {
                 .removed(types.getType(ChangelogEntryType.REMOVED))
                 .fixed(types.getType(ChangelogEntryType.FIXED))
                 .security(types.getType(ChangelogEntryType.SECURITY))
+                .dependencyUpdate(types.getType(ChangelogEntryType.DEPENDENCY_UPDATE))
                 .other(types.getType(ChangelogEntryType.SECURITY))
                 .numberOfChanges(YMLNumberOfChangesLabels.of(types.getNumberOfChanges()))
                 .build();
@@ -66,6 +70,7 @@ public TypesLabels to() {
                 .removed(removed)
                 .fixed(fixed)
                 .security(security)
+                .dependencyUpdate(dependencyUpdate)
                 .other(other)
                 .numberOfChanges(getNumberOfChanges().to())
                 .build();

diff --git a/...src/test/resources/ChangelogEntryTypeLabelIntegrationTest/EXPECTED_CHANGELOG.md b/...src/test/resources/ChangelogEntryTypeLabelIntegrationTest/EXPECTED_CHANGELOG.md
@@ -31,6 +31,10 @@
 
 - Test title 1 !1 !2 #1 [TASK_NUMBER](https://www.google.pl) (@marwin1991 [LINK](https://github.com/marwin1991))
 
+### Aktualizacje zależności (1 zmiana)
+
+- Test title 6 ([Piotr](https://github.com/marwin1991) @marwin1991)
+
 ### Inne (2 zmian/y)
 
 - Test title 3 !1 #1 [TASK_NUMBER](https://www.google.pl) (Piotr)