python-kacl 0.6.6__py3-none-any.whl → 0.6.7__py3-none-any.whl

kacl/__init__.py

@@ -1,5 +1,5 @@
 # Version of the python-kacl package
-__version__ = "0.6.6"
+__version__ = "0.6.7"
 
 from kacl.document import KACLDocument
 from kacl.serializer import KACLMarkdownSerializer

kacl/config/kacl-default.yml

@@ -13,6 +13,8 @@ kacl:
   default_content:
     - All notable changes to this project will be documented in this file.
     - The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+  release:
+    add_unreleased: True
   git:
     commit: False
     commit_message: "[skip ci] Releasing Changelog version {new_version}"

kacl/config.py

@@ -20,6 +20,9 @@ class KACLConfig:
         self.allowed_header_titles = self.__config.get("allowed_header_titles")
         self.allowed_version_sections = self.__config.get("allowed_version_sections")
         self.default_content = self.__config.get("default_content")
+        self.add_unreleased = self.__config.get("release", {}).get(
+            "add_unreleased", True
+        )
         self.git_tag_name = self.__config.get("git", {}).get("tag_name")
         self.git_tag_description = self.__config.get("git", {}).get("tag_description")
         self.changelog_file_path = self.__config.get("file")

kacl/document.py

@@ -430,13 +430,9 @@ class KACLDocument:
         # remove current unrelease version from list
         self.__versions.pop(0)
 
-        self.__versions.insert(
-            0, KACLVersion(version="Unreleased", link=unreleased_version.link())
-        )
-
         # convert unreleased version to version
         self.__versions.insert(
-            1,
+            0,
             KACLVersion(
                 version=version,
                 link=KACLElement(title=version, body=link),
@@ -445,6 +441,11 @@ class KACLDocument:
             ),
         )
 
+        if self.config.add_unreleased:
+            self.__versions.insert(
+                0, KACLVersion(version="Unreleased", link=unreleased_version.link())
+            )
+
         if auto_link:
             link_provider = self.__get_link_provider()
             for i in range(2):

kacl/kacl_cli.py

@@ -150,10 +150,11 @@ def add(ctx, section, message, modify, stash):
 
     kacl_changelog_content = kacl.dump(kacl_changelog)
     # if stashing is enabled, do not modify the changelog file
-    if modify and not stash:
-        with open(kacl_changelog.config.changelog_file_path, "w") as f:
-            f.write(kacl_changelog_content)
-        f.close()
+    if modify:
+        if not stash:
+            with open(kacl_changelog.config.changelog_file_path, "w") as f:
+                f.write(kacl_changelog_content)
+            f.close()
     else:
         click.echo(kacl_changelog_content)
 

{python_kacl-0.6.6.dist-info → python_kacl-0.6.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-kacl
-Version: 0.6.6
+Version: 0.6.7
 Summary: Python module and CLI tool for validating and modifying Changelogs in "keep-a-changelog" format"
 Home-page: https://gitlab.com/schmieder.matthias/python-kacl.git
 Author: Matthias Schmieder
@@ -355,8 +355,9 @@ kacl-cli get 0.2.2
 ```
 Usage: kacl-cli add [OPTIONS] SECTION MESSAGE
 
-  Adds a given message to a specified unreleased section. Use '--modify' to
-  directly modify the changelog file.
+  Adds a given message to a specified unreleased section. A new unreleased
+  section is added if it doesn't exist. Use '--modify' to directly modify
+  the changelog file.
 
 Options:
   -m, --modify  This option will add the changes directly into changelog file
@@ -378,7 +379,9 @@ Usage: kacl-cli release [OPTIONS] VERSION
 
   Creates a release for the latest 'unreleased' changes. Use '--modify' to
   directly modify the changelog file. You can automatically use the latest
-  version by using the version keywords 'major', 'minor', 'patch', 'post'
+  version by using the version keywords 'major', 'minor', 'patch', 'post'.
+  Creates a new empty unreleased section if not disabled in the configuration
+  file.
 
   Example:
 
@@ -866,6 +869,8 @@ kacl:
   default_content:
     - All notable changes to this project will be documented in this file.
     - The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+  release:
+    add_unreleased: True
   git:
     commit: False
     commit_message: "[skip ci] Releasing Changelog version {new_version}"
@@ -919,6 +924,8 @@ kacl:
 | `git.tag`                               | boolean | `false`                                                              | Automatically create git tags during release             |
 | `git.tag_name`                          | string  | `"v{new_version}"`                                                   | Template for git tag names                               |
 | `git.tag_description`                   | string  | `"Version v{new_version} released"`                                  | Template for git tag descriptions                        |
+| **Release Settings**                    |         |                                                                      |                                                          |
+| `release.add_unreleased`                | boolean | `true`                                                               | Automatically add new "Unreleased" section after release |
 | **Link Generation**                     |         |                                                                      |                                                          |
 | `links.auto_generate`                   | boolean | `false`                                                              | Automatically generate version links during release      |
 | `links.compare_versions_template`       | string  | `"{host}/compare/{previous_version}...{version}"`                    | Template for version comparison links                    |
@@ -961,7 +968,7 @@ cd python-kacl
 
 # create a virtual env
 python3 -m venv .venv
-source ./venv/bin/activate
+source ./.venv/bin/activate
 
 # install in development mode
 pip install -e .

{python_kacl-0.6.6.dist-info → python_kacl-0.6.7.dist-info}/RECORD

@@ -1,22 +1,22 @@
-kacl/__init__.py,sha256=Xz1MhC4G8ciUa0ezKXgEEYqJkoUeonsA7neF8DS-bYg,667
+kacl/__init__.py,sha256=LVMIQ2xATXmaQ0FdcE9sRrOy2X7w-s6DKQHtZgSLNpA,667
 kacl/__main__.py,sha256=cpulIGoFUJNN5ZW9oUoNN1PnBvrOyJ24xwtpf_yRwgQ,91
 kacl/changes.py,sha256=Speu1KLMNQVn0U2BMaO8ta4IEaQLTQtpW0IhN0JjGdY,704
-kacl/config.py,sha256=mUPm4W0cW7kvwYG4L20B38V-AvguvD6jvIQtZDO5mPY,4129
-kacl/document.py,sha256=OuVjqSEUTxvO6tiCWggQiNebfjoTwQyIuqlT2y_V9Yc,28712
+kacl/config.py,sha256=c2QiP-BriJJwzrw36oigJWKe6t4o6yhmN_nPSL6bcRk,4242
+kacl/document.py,sha256=oNnxlXWEh4yfqK4dK8xhzjWrUPHbUizEj_PQhP73poQ,28763
 kacl/element.py,sha256=OG02QI8ND5fJpBMceT6dbIHr4uX9gLxK_fPCsOvMDHI,416
 kacl/exception.py,sha256=MfOVpUvhcQtm10rSY__74-oLo445PG8mLFGJPPIfXH0,41
 kacl/jira_client.py,sha256=KPE94bZDkJFKw3okFsCgf2DjoyMlUUTMZKtQGKreVQY,989
-kacl/kacl_cli.py,sha256=SnukzW96DjlPunZ5WOUxlPAsjUI-dg3iMeV1y9pyxKg,22156
+kacl/kacl_cli.py,sha256=RshCxLhh5YJa6tzl8f5dnLOYF3Kbl-EDD4m21hIJDPw,22176
 kacl/link_provider.py,sha256=tgvMYhJe2ErH1m_qXMlQEacq9Cg_KGp_-sF03sVFP6E,1866
 kacl/parser.py,sha256=EUtRjgaW0beWVqiYaRJ9Rcf6jbuGoTgWzVBdOdUHnv8,2587
 kacl/serializer.py,sha256=PdR2FFCh9rbBhkxXwUYD0fSjQqTG_Mb6mYws3lNAWQ8,3090
 kacl/utils.py,sha256=bHiDDmjoYB868Bm732vNjpfML-6xcNQQqS7NQn_Sfm0,2824
 kacl/validation.py,sha256=b9r_5CyY6Cmi9BePh47IgZ3j64zdVsoB_fFvucieNbw,2125
 kacl/version.py,sha256=IDYCWIIXzxdYyMptUAidMgf0SXJqoETFVJ8NVyKgA9A,9526
-kacl/config/kacl-default.yml,sha256=KGOLn-BKj_8J0F3nBpSjH8ywdCjQQelhdDOKZ1pOy_Q,1477
-python_kacl-0.6.6.dist-info/licenses/LICENSE,sha256=TRSJOIt7LZuMeZXFleJVL_LHczSxqi70HEiTLT-kI8Q,1075
-python_kacl-0.6.6.dist-info/METADATA,sha256=OZ-3KPX7dyJYFyO_kBdHuwsI6pLJlNhZS3rWWPVcJa0,37608
-python_kacl-0.6.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-python_kacl-0.6.6.dist-info/entry_points.txt,sha256=rXqqJKfm6Y7fYfioq_7ay2VWOOM9C-hts1IsoGTtojM,76
-python_kacl-0.6.6.dist-info/top_level.txt,sha256=BcmQgo67JyGnVZ3Jc0Ag8hKMGVOqXc8ex01zW4Njw5M,5
-python_kacl-0.6.6.dist-info/RECORD,,
+kacl/config/kacl-default.yml,sha256=cXHl_w04SW0HA7OyJMMuaC6DTeXlhI2Sfsx7lygTPf4,1513
+python_kacl-0.6.7.dist-info/licenses/LICENSE,sha256=TRSJOIt7LZuMeZXFleJVL_LHczSxqi70HEiTLT-kI8Q,1075
+python_kacl-0.6.7.dist-info/METADATA,sha256=WXFDjyEQ1jS_sJyzfcHgx3wfq9OijduqLo1KYSkYpXY,38157
+python_kacl-0.6.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+python_kacl-0.6.7.dist-info/entry_points.txt,sha256=rXqqJKfm6Y7fYfioq_7ay2VWOOM9C-hts1IsoGTtojM,76
+python_kacl-0.6.7.dist-info/top_level.txt,sha256=BcmQgo67JyGnVZ3Jc0Ag8hKMGVOqXc8ex01zW4Njw5M,5
+python_kacl-0.6.7.dist-info/RECORD,,