Fix changelog check

devtools/check_changelog.py

@@ -5,11 +5,10 @@
 
 * additions are reported in CHANGELOG.rst
 """
+import os
 from pathlib import Path
 
-folder = Path(__file__).resolve().parents[1]
-changelog = Path('docs', 'CHANGELOG.rst')
-contributing = Path('docs', 'CONTRIBUTING.rst')
+import git
 
 
 class ChangelogError(Exception):
@@ -18,13 +17,24 @@ class ChangelogError(Exception):
     pass
 
 
-with open(Path(folder, changelog), 'r') as fin:
+folder = Path(__file__).resolve().parents[1]
+changelog = Path("docs", "CHANGELOG.rst")
+contributing = Path("docs", "CONTRIBUTING.rst")
+
+repo = git.Repo(folder)
+
+if repo.active_branch.name == "main":
+    print("You are on the main branch. Nothing to check.")
+    exit(0)
+
+with open(Path(folder, changelog), "r") as fin:
     for line in fin:
-        if line.startswith('v'):
+        if line.startswith("v"):
             raise ChangelogError(
-                'You have not updated the CHANGELOG file. '
-                f'Please add a summary of your additions to {str(changelog)!r} '
-                f'as described in {str(contributing)!r}.'
-                )
-        elif line.startswith('*'):
-            break
+                "You have not updated the CHANGELOG file. "
+                f"Please add a summary of your additions to {str(changelog)!r} "
+                f"as described in {str(contributing)!r}."
+            )
+        elif line.startswith("*"):
+            print("Changelog updated.")
+            exit(0)

docs/CHANGELOG.rst

@@ -2,8 +2,7 @@
 Changelog
 =========
 
-* Replace Boolean ``debug`` option in  ``setup_logging`` by more flexible integer
-  ``level`` parameter.
+* Change handling of CHANGELOG checks
 
 v0.1.30 (2024-04-03)
 ------------------------------------------

tox.ini

@@ -71,7 +71,6 @@ skip_install = true
 commands_pre = python {toxinidir}/devtools/clean_dist_check.py
 commands =
     python --version
-    python {toxinidir}/devtools/check_changelog.py
     python -m build
     twine check dist/*.whl
     twine check dist/*.tar.gz
@@ -95,8 +94,10 @@ commands =
 usedevelop = true
 deps =
     -r{toxinidir}/devtools/docs_requirements.txt
+    gitpython
 commands =
     sphinx-build {posargs:-E} -b html docs/rst dist/docs
+    python {toxinidir}/devtools/check_changelog.py
 
 [testenv:safety]
 deps = safety