python-kacl 0.6.6__tar.gz → 0.6.7__tar.gz

{python_kacl-0.6.6/python_kacl.egg-info → python_kacl-0.6.7}/PKG-INFO

@@ -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 → python_kacl-0.6.7}/README.md

@@ -322,8 +322,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
@@ -345,7 +346,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:
 
@@ -833,6 +836,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}"
@@ -886,6 +891,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                    |
@@ -928,7 +935,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 → python_kacl-0.6.7}/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

{python_kacl-0.6.6 → python_kacl-0.6.7}/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}"

{python_kacl-0.6.6 → python_kacl-0.6.7}/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")

{python_kacl-0.6.6 → python_kacl-0.6.7}/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):

{python_kacl-0.6.6 → python_kacl-0.6.7}/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 → python_kacl-0.6.7/python_kacl.egg-info}/PKG-INFO

@@ -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 → python_kacl-0.6.7}/setup.py

@@ -11,7 +11,7 @@ this_directory = path.abspath(path.dirname(__file__))
 with open(path.join(this_directory, "README.md"), encoding="utf-8") as f:
     long_description = f.read()
 
-version = "0.6.6"
+version = "0.6.7"
 
 version = f"{version}{os.environ.get('PIP_VERSION_POSTFIX', '')}"
 

{python_kacl-0.6.6 → python_kacl-0.6.7}/tests/test_cli.py

@@ -285,6 +285,31 @@ def test_release_major(tmp_path, snapshot):
         snapshot_directory(snapshot=snapshot, directory_path=project_root_path)
 
 
+@freeze_time("2023-01-01")
+def test_release_major_no_unreleased(tmp_path, snapshot):
+    runner = CliRunner()
+    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
+    changelog_file = os.path.join(resources_dir, "CHANGELOG_with_changes.md")
+
+    with runner.isolated_filesystem(temp_dir=tmp_path) as project_root_path:
+        shutil.copyfile(changelog_file, os.path.join(project_root_path, "CHANGELOG.md"))
+        result = runner.invoke(
+            cli,
+            [
+                "-c",
+                os.path.join(resources_dir, "no-unreleased-config.yml"),
+                "-f",
+                "CHANGELOG.md",
+                "release",
+                "major",
+                "-m",
+            ],
+            catch_exceptions=False,
+        )
+        assert result.exit_code == 0, result.output
+        snapshot_directory(snapshot=snapshot, directory_path=project_root_path)
+
+
 @freeze_time("2023-01-01")
 def test_release_custom(tmp_path, snapshot):
     runner = CliRunner()
@@ -308,6 +333,34 @@ def test_release_custom(tmp_path, snapshot):
         snapshot_directory(snapshot=snapshot, directory_path=project_root_path)
 
 
+@freeze_time("2023-01-01")
+def test_release_no_change(tmp_path, snapshot):
+    runner = CliRunner()
+    resources_dir = os.path.join(os.path.dirname(os.path.realpath(__file__)), "data/")
+    changelog_file = os.path.join(resources_dir, "CHANGELOG_without_changes.md")
+
+    with runner.isolated_filesystem(temp_dir=tmp_path) as project_root_path:
+        shutil.copyfile(changelog_file, os.path.join(project_root_path, "CHANGELOG.md"))
+        result = runner.invoke(
+            cli,
+            [
+                "-f",
+                "CHANGELOG.md",
+                "release",
+                "2.1.1",
+            ],
+            catch_exceptions=False,
+        )
+        assert result.exit_code == 1, result.output
+
+        result = runner.invoke(
+            cli,
+            ["-f", "CHANGELOG.md", "release", "2.1.1", "-m"],
+            catch_exceptions=False,
+        )
+        assert result.exit_code == 1, result.output
+
+
 @freeze_time("2023-01-01")
 def test_add_change_security(tmp_path, snapshot):
     runner = CliRunner()