python-kacl 0.7.6__py3-none-any.whl → 0.7.7__py3-none-any.whl

kacl/__init__.py

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

kacl/document.py

@@ -229,10 +229,11 @@ class KACLDocument:
                 pass
 
         # 4 link references
-        # 4.1 check that there are only linked references
-        version_strings = [v.version().lower() for v in versions]
-        for v, link in self.__link_references.items():
-            if v.lower() not in version_strings:
+        # 4.1 check that every reference is either a version link or is used
+        # inside of the changelog (e.g. "[!1234]" pointing to a merge request)
+        content = self._referencable_content().lower()
+        for link in self.extra_link_references():
+            if f"[{link.title().lower()}]" not in content:
                 validation.add_error(
                     line=link.raw(),
                     line_number=link.line_number(),
@@ -243,6 +244,27 @@ class KACLDocument:
 
         return validation
 
+    def extra_link_references(self):
+        """Returns all link references that do not belong to a version."""
+        version_strings = [v.version().lower() for v in self.__versions]
+        return [
+            link
+            for label, link in self.__link_references.items()
+            if label.lower() not in version_strings
+        ]
+
+    def _referencable_content(self):
+        """Returns the text of all versions in which link references can be used."""
+        parts = []
+        for v in self.__versions:
+            parts.append(v.body() or "")
+            try:
+                for changes in v.sections().values():
+                    parts.extend(changes.items())
+            except ValueError:
+                pass
+        return "\n".join(parts)
+
     def is_valid(self):
         """Checks if the current changelog is valid
         Returns:
@@ -289,6 +311,8 @@ class KACLDocument:
                         else:
                             change = f"[{v.version()}] {change}"
                     squash_version.add(section, change)
+            # the squashed version is gone, so is its link reference
+            self.__link_references.pop(v.version().lower(), None)
 
         versions_unsquashed.append(squash_version)
         versions_unsquashed.sort(reverse=True)

kacl/serializer.py

@@ -30,6 +30,10 @@ class KACLMarkdownSerializer:
                 if version.has_link_reference():
                     link_references.append(self.__serialize_link_reference(version))
 
+            # keep references that do not belong to a version (e.g. merge requests)
+            for link in document.extra_link_references():
+                link_references.append(f"[{link.title()}]: {link.body()}")
+
         elif isinstance(document, KACLVersion):
             data.extend([self.__serialize_version(document), ""])
 

{python_kacl-0.7.6.dist-info → python_kacl-0.7.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-kacl
-Version: 0.7.6
+Version: 0.7.7
 Summary: Python module and CLI tool for validating and modifying Changelogs in "keep-a-changelog" format"
 Author-email: Matthias Schmieder <schmieder.matthias@gmail.com>
 License: MIT
@@ -56,6 +56,7 @@ A tool for verifying and modifying changelog in the [**K**eep-**A-C**hange-**L**
     - [Workflow Integration](#workflow-integration)
     - [Benefits](#benefits)
   - [Link Generation](#link-generation)
+    - [Custom Link References](#custom-link-references)
   - [Squashing releases](#squashing-releases)
     - [Example](#example)
   - [Issue Management Integration](#issue-management-integration)
@@ -778,6 +779,25 @@ kacl:
 
 Using the python format syntax you can generate any links you want. The available replacement variables are `version`, `previous_version`, `host` and `latest_version`.
 
+### Custom Link References
+
+Besides version links, you can use your own link references in changelog entries, for example to link to merge requests or issues. A reference is accepted as long as `[label]` is used in at least one entry:
+
+```markdown
+## [1.0.0] - 2026-04-10
+
+### Changed
+
+- a big change ([!1234])
+
+[1.0.0]: https://gitlab.com/my/repo/-/tags/v1.0.0
+[!1234]: https://gitlab.com/my/repo/-/merge_requests/1234
+```
+
+- `kacl-cli verify` reports references that are never used with `Link not referenced anywhere in the document`.
+- Custom references are preserved when `kacl-cli` rewrites the changelog (`add`, `release`, ...). They are written after the version links.
+- `kacl-cli squash` removes the references of the squashed versions.
+
 ## Squashing releases
 
 If you are follwing a automated versioning approach, you will often times create a number of versions that might clutter Changelog. For this purpose, `kacl-cli` provides a `squash` command that let's you squash releases into a single one without loosing valuable information.

{python_kacl-0.7.6.dist-info → python_kacl-0.7.7.dist-info}/RECORD

@@ -1,22 +1,22 @@
-kacl/__init__.py,sha256=TSKqPUQPsZJN1hgqqbXv4rRZl2vA0GBEhQFvsmfzHtw,667
+kacl/__init__.py,sha256=7gjIG9nyG7Y0PfI8dPh73XnYtnzRut358actaFEi3j4,667
 kacl/__main__.py,sha256=cpulIGoFUJNN5ZW9oUoNN1PnBvrOyJ24xwtpf_yRwgQ,91
 kacl/changes.py,sha256=Speu1KLMNQVn0U2BMaO8ta4IEaQLTQtpW0IhN0JjGdY,704
 kacl/config.py,sha256=c2QiP-BriJJwzrw36oigJWKe6t4o6yhmN_nPSL6bcRk,4242
-kacl/document.py,sha256=4BGvRpbr5JxMRoBPuN_oGTjVNTyjHFcl-xB4rhjEOIY,31767
+kacl/document.py,sha256=SasVN1iXmE7q-hfFZpifKLXiyTjX8qF2Qwu1B63eAhc,32760
 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=LzwnB990BpwL5nrKi4EbeDSWuT_CMd4rdqo6kTrlARw,24184
 kacl/link_provider.py,sha256=tgvMYhJe2ErH1m_qXMlQEacq9Cg_KGp_-sF03sVFP6E,1866
 kacl/parser.py,sha256=EUtRjgaW0beWVqiYaRJ9Rcf6jbuGoTgWzVBdOdUHnv8,2587
-kacl/serializer.py,sha256=g5eFim8OpSbgyShyFANSwOEbAfJqCNUXaRJtPO79blc,3931
+kacl/serializer.py,sha256=bNLlcdu-Pkd9IfDphjQaE-iqcos92Yy82ReuvJ91fZw,4149
 kacl/utils.py,sha256=4iWIJVNtv22v0IGXDjuEATPMQsJBr5Ycy9Q2zV2jkHE,2835
 kacl/validation.py,sha256=b9r_5CyY6Cmi9BePh47IgZ3j64zdVsoB_fFvucieNbw,2125
 kacl/version.py,sha256=Rh0DpHqjrkoPhemWEzRMu11U7DY1f8PvCh30zwggF5I,10692
 kacl/config/kacl-default.yml,sha256=cXHl_w04SW0HA7OyJMMuaC6DTeXlhI2Sfsx7lygTPf4,1513
-python_kacl-0.7.6.dist-info/licenses/LICENSE,sha256=TRSJOIt7LZuMeZXFleJVL_LHczSxqi70HEiTLT-kI8Q,1075
-python_kacl-0.7.6.dist-info/METADATA,sha256=4zMhPmNR_e0v0xOFoRZ8wh4r_yN_mwKmSUU9tPuSZ8E,42453
-python_kacl-0.7.6.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
-python_kacl-0.7.6.dist-info/entry_points.txt,sha256=rXqqJKfm6Y7fYfioq_7ay2VWOOM9C-hts1IsoGTtojM,76
-python_kacl-0.7.6.dist-info/top_level.txt,sha256=BcmQgo67JyGnVZ3Jc0Ag8hKMGVOqXc8ex01zW4Njw5M,5
-python_kacl-0.7.6.dist-info/RECORD,,
+python_kacl-0.7.7.dist-info/licenses/LICENSE,sha256=TRSJOIt7LZuMeZXFleJVL_LHczSxqi70HEiTLT-kI8Q,1075
+python_kacl-0.7.7.dist-info/METADATA,sha256=Y-pZnC2OxToMI6lO5ix4FjjXzlBak747--wO1uKqM1U,43256
+python_kacl-0.7.7.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+python_kacl-0.7.7.dist-info/entry_points.txt,sha256=rXqqJKfm6Y7fYfioq_7ay2VWOOM9C-hts1IsoGTtojM,76
+python_kacl-0.7.7.dist-info/top_level.txt,sha256=BcmQgo67JyGnVZ3Jc0Ag8hKMGVOqXc8ex01zW4Njw5M,5
+python_kacl-0.7.7.dist-info/RECORD,,