Add changelog-keeper integration

Author: taminomara

.github/workflows/ci.yaml

@@ -126,13 +126,12 @@ jobs:
           ref="${{ github.ref }}";
           version=${ref#refs/tags/v};
           link="https://pypi.org/p/sphinx-lua-ls/${version}";
-          echo "version=${version}" >> $GITHUB_OUTPUT
           echo "link=${link}" >> $GITHUB_OUTPUT
       - name: Parse Changelog
         id: changelog
-        uses: mindsers/changelog-reader-action@v2
+        uses: taminomara/cl-keeper@v0
         with:
-          version: ${{ steps.metadata.outputs.version }}
+          version: ${{ github.ref }}
       - name: Set up python 3.12
         uses: actions/setup-python@v4
         with:
@@ -150,11 +149,11 @@ jobs:
       - name: Create GitHub release
         uses: softprops/action-gh-release@v2
         with:
-          prerelease: ${{ steps.changelog.outputs.status == 'prereleased' }}
-          draft: ${{ steps.changelog.outputs.status == 'unreleased' }}
+          prerelease: ${{ fromJSON(steps.changelog.outputs.is-pre-release) }}
+          draft: ${{ fromJSON(steps.changelog.outputs.is-unreleased) }}
           body: |
             ## Changelog
 
-            ${{ steps.changelog.outputs.changes }}
+            ${{ steps.changelog.outputs.text }}
 
             [See release on PyPi](${{ steps.metadata.outputs.link }})

.pre-commit-config.yaml

@@ -13,6 +13,20 @@ repos:
         entry: isort --filter-files
         types_or: [python, pyi]
         require_serial: true
+      - id: clk
+        name: changelog keeper
+        language: system
+        entry: clk pre-commit-check
+        require_serial: true
+        types_or: [toml, yaml, markdown]
+      - id: clk-tags
+        name: changelog keeper (check tags)
+        language: system
+        entry: clk pre-commit-check-tag
+        always_run: true
+        pass_filenames: false
+        require_serial: true
+        stages: [pre-push]
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v6.0.0
     hooks:

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sphinx-lua-ls"
-authors = [{name = "Tamika Nomara", email = "taminomara@gmail.com"}]
+authors = [{ name = "Tamika Nomara", email = "taminomara@gmail.com" }]
 description = "Automatic documentation generation via EmmyLua/LuaLs"
 dynamic = ["version"]
 readme = "README.md"
@@ -21,37 +21,34 @@ classifiers = [
     "Topic :: Documentation :: Sphinx",
     "Typing :: Typed",
 ]
-dependencies = [
-    "sphinx>=8.0,<10.0",
-    "PyGithub>=1.59,<3.0",
-    "requests~=2.31",
-]
+dependencies = ["sphinx>=8.0,<10.0", "PyGithub>=1.59,<3.0", "requests~=2.31"]
 
 [dependency-groups]
 dev = [
     "pytest-cov==7.0.0",
-    {include-group = "test"},
-    {include-group = "lint"},
-    {include-group = "doc"},
+    { include-group = "test" },
+    { include-group = "lint" },
+    { include-group = "doc" },
 ]
 lint = [
     "black==26.1.0",
     "isort==7.0.0",
     "pre-commit==4.5.1",
+    "cl-keeper==0.0.0-b6",
 ]
 test = [
     "pyright==1.1.408",
     "pytest==9.0.2",
     "sybil==9.3.0",
     "pytest-regressions==2.9.1",
     "beautifulsoup4==4.14.3",
-    "myst-parser==5.0.0"
+    "myst-parser==5.0.0",
 ]
 doc = [
     "sybil==9.3.0",
     "furo==2025.12.19",
     "sphinx_design==0.7.0",
-    "myst-parser==5.0.0"
+    "myst-parser==5.0.0",
 ]
 
 [project.urls]