Move Changelog to seperate file

Author: Martin Møldrup

.github/workflows/release.yaml

@@ -79,7 +79,7 @@ jobs:
             echo "README.md file not found."
             exit 1
           fi
-          CHANGELOG=$(awk '/^## \['${{ needs.details.outputs.new_version }}'\]/,/^## \[/' README.md | sed '1d;$d')
+          CHANGELOG=$(awk '/^## \['${{ needs.details.outputs.new_version }}'\]/,/^## \[/' CHANGELOG.md | sed '1d;$d')
           if [ -z "$CHANGELOG" ]; then
             echo "Changelog for version ${{ needs.details.outputs.new_version }} not found."
             exit 1

CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## [0.2.0]
+- Better error messages by using pytest assertion rewriting
+- Allow users to set the snapshot directory when using the load_snapshot fixture
+  
+## [0.1.1]
+- Update dependencies with the lower bounds of package compatibility
+- Refactor to make code easier for users of package to modify and extend
+
+## [0.1.0]
+- Added fixture for loading snapshots from previous tests (load_snapshot fixture)
+- Added the snappylapy marker for tests that depend on previous tests (pytest.mark.snappylapy). This will be used for more advanced features in the future.
+
+## [0.0.2]
+- 🐞 Added fix for python 3.9, by refactoring incompatible type annotation
+- Loosened the version requirements for pytest (until the lower bound have been discovered, with automated testing)
+- Improved metadata for pypi
+
+## [0.0.1]
+- Initial release of Snappylapy
+- Implemented basic snapshot testing functionality for dict, list, bytes and str data types

README.md

@@ -160,25 +160,3 @@ Snappylapy is your go-to tool for efficient and reliable snapshot testing in Pyt
 
 # Contributing
 We welcome contributions to Snappylapy! If you have ideas for new features, improvements, or bug fixes, please open an issue or submit a pull request on our GitHub repository. We appreciate your feedback and support in making Snappylapy even better for the community.
-
-# Change Log
-## [0.2.0]
-- Better error messages by using pytest assertion rewriting
-- Allow users to set the snapshot directory when using the load_snapshot fixture
-  
-## [0.1.1]
-- Update dependencies with the lower bounds of package compatibility
-- Refactor to make code easier for users of package to modify and extend
-
-## [0.1.0]
-- Added fixture for loading snapshots from previous tests (load_snapshot fixture)
-- Added the snappylapy marker for tests that depend on previous tests (pytest.mark.snappylapy). This will be used for more advanced features in the future.
-
-## [0.0.2]
-- 🐞 Added fix for python 3.9, by refactoring incompatible type annotation
-- Loosened the version requirements for pytest (until the lower bound have been discovered, with automated testing)
-- Improved metadata for pypi
-
-## [0.0.1]
-- Initial release of Snappylapy
-- Implemented basic snapshot testing functionality for dict, list, bytes and str data types

docs/changelog.md

@@ -0,0 +1 @@
+--8<-- "CHANGELOG.md"

mkdocs.yml

@@ -1,6 +1,6 @@
 site_name: Snappylapy
 repo_name: martinmoldrup/snappylapy
-repo_url: https://dev.azure.com/GFIOSvr/AI%20Circle/_git/AzureSharedPkg
+repo_url: https://github.com/martinmoldrup/snappylapy
 
 theme:
   name: material
@@ -66,4 +66,5 @@ markdown_extensions:
 
 nav:
   - Home: index.md
-  - Code Reference: reference/
+  - Code Reference: reference/
+  - Changelog: changelog.md

pyproject.toml

@@ -3,7 +3,7 @@ name = "snappylapy"
 version = "0.2.0"
 description = "A snapshot library for python optimized for easy of use, human readable snapshots and enabling decoupling of chained integration tests."
 authors = ["Martin Møldrup"]
-readme = "README.md"
+readme = ["README.md", "CHANGELOG.md"]
 classifiers = [
     "Framework :: Pytest",
     "Development Status :: 4 - Beta",
@@ -23,6 +23,7 @@ classifiers = [
 ]
 packages = [{ include = "snappylapy" }, { include = "snappylapy/py.typed" }]
 repository = "https://github.com/martinmoldrup/snappylapy"
+documentation = "https://martinmoldrup.github.io/snappylapy"
 
 keywords = ["pytest", "snapshot", "testing", "snapshot-testing", "integration-testing", "unit-testing"]
 

scripts/create_new_release.py

@@ -7,7 +7,7 @@
 from packaging.version import Version
 
 PYPROJECT_TOML = pathlib.Path(__file__).parent.parent / "pyproject.toml"
-README_MD = pathlib.Path(__file__).parent.parent / "README.md"
+CHANGELOG_MD = pathlib.Path(__file__).parent.parent / "CHANGELOG.md"
 PYPI_ENDPOINT = "https://pypi.org/pypi/snappylapy/json"
 
 def read_version():
@@ -26,12 +26,12 @@ def check_version(version: str):
 
 def check_change_log(version: str):
     """Check if the version has a corresponding entry in the change log. It will be a line starting with ## [0.0.2]"""
-    with open(README_MD, "r", encoding="utf-8") as file:
+    with open(CHANGELOG_MD, "r", encoding="utf-8") as file:
         lines = file.readlines()
     version_str = f"## [{version}]"
     if not any(line.startswith(version_str) for line in lines):
         raise ValueError(f"Version {version} does not have a corresponding entry in the change log.")
-    
+
 
 
 if __name__ == "__main__":