Skip to content

Commit 194e1a4

Browse files
committed
Update CHANGELOG and README for improved clarity and badge links
1 parent a8ea9dc commit 194e1a4

File tree

2 files changed

+18
-7
lines changed

2 files changed

+18
-7
lines changed

CHANGELOG.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,18 @@ All notable changes to this project will be documented in this file.
33

44
*NOTE:* Version 0.X.X might have breaking changes in bumps of the minor version number. This is because the project is still in early development and the API is not yet stable. It will still be marked clearly in the release notes.
55

6-
## [0.8.0]
6+
Icons:
7+
- 🆕 New feature
8+
- 🐞 Bug fix
9+
- 🗑️ Deprecated feature
10+
- 💥 Breaking change
11+
- 🔄 Changed
12+
13+
## [0.8.0] - 2025-10-18
714
- 🆕 Used integration with toolit to make snappylapy commands available for AI coding assistants
8-
- ❗Deprecated support for Python 3.9. Snappylapy now requires Python 3.10 or higher. Add python 3.14 to the test matrix.
15+
- 🆕 Add a `@configure_snappylapy()` decorator as an alternative for using @pytest.mark.snappylapy for improved documentation support, type checking and IDE integration.
16+
- 🔄 Improve documentation and examples for using snappylapy for advanced snapshot testing scenarios.
17+
- 🗑️ Deprecated support for Python 3.9. Snappylapy now requires Python 3.10 or higher. Add Python 3.14 to the test matrix.
918

1019
## [0.7.0] - 2025-08-27
1120
- 🆕 Added csv serializer for pandas dataframes for making the deserialization work on windows and make a more suitable and human readable format.
@@ -43,9 +52,10 @@ All notable changes to this project will be documented in this file.
4352
- Add snappylapy parametization functionality to snappylapy and allow it to be loaded in the load_snapshot fixture
4453
- Do reporting showing count of updated, created and deleted snapshots
4554
- **Breaking Changes**
46-
- Change setting of path to only have a single path configurable and update such it is configured through the marker
47-
- Make the folder names of __snapshots__ and __test_results__ enforced to be fixed (needed for cleanup and diffing)
48-
- Rename output file names of snapshots to match [filename][testname][name].extention conversion
55+
- 💥 Change setting of path to only have a single path configurable and update such it is configured through the marker
56+
- 💥 Make the folder names of __snapshots__ and __test_results__ enforced to be fixed (needed for cleanup and diffing)
57+
- 💥 Rename output file names of snapshots to match [filename][testname][name].extention conversion
58+
4959
## [0.2.1] - 2025-01-13
5060
- Added missing dependency for typer to make the CLI work
5161

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,17 @@ Effortlessly capture, diff, and reuse complex, non-deterministic, and AI-generat
1111
</p>
1212
<!-- Badges -->
1313
<p align="center">
14-
<a href="https://img.shields.io/badge/status-beta-yellow"><img src="https://img.shields.io/badge/status-beta-yellow" alt="Beta Status"/></a>
14+
<a href="https://github.com/martinmoldrup/snappylapy/blob/main/CHANGELOG.md"><img src="https://img.shields.io/badge/status-beta-yellow" alt="Beta Status"/></a>
1515
<a href="https://github.com/martinmoldrup/snappylapy/blob/main/LICENSE"><img src="https://img.shields.io/github/license/martinmoldrup/snappylapy" alt="License"/></a>
1616
<a href="https://martinmoldrup.github.io/snappylapy/"><img src="https://img.shields.io/badge/docs-MkDocs-blue" alt="Documentation"/></a>
17-
<a href="https://github.com/martinmoldrup/snappylapy/tags"><img src="https://img.shields.io/github/v/tag/martinmoldrup/snappylapy?label=version&logo=github&color=purple" alt="Version"/></a>
17+
<a href="https://github.com/martinmoldrup/snappylapy/blob/main/CHANGELOG.md"><img src="https://img.shields.io/github/v/tag/martinmoldrup/snappylapy?label=version&logo=github&color=purple" alt="Version"/></a>
1818
<br/>
1919
<!-- Quality Assurance steps. Note the success of these steps is enforced in the CI pipeline. -->
2020
<a href="https://github.com/martinmoldrup/snappylapy/actions/workflows/continuous_integration.yaml"><img src="https://img.shields.io/badge/type%20check-mypy-success?logo=python" alt="mypy"/></a>
2121
<a href="https://github.com/martinmoldrup/snappylapy/actions/workflows/continuous_integration.yaml"><img src="https://img.shields.io/badge/lint-ruff-success?logo=ruff" alt="ruff"/></a>
2222
<a href="https://github.com/martinmoldrup/snappylapy/actions/workflows/continuous_integration.yaml"><img src="https://img.shields.io/badge/tested%20with-pytest-success?logo=pytest" alt="pytest"/></a>
2323
<a href="https://github.com/martinmoldrup/snappylapy/blob/main/pyproject.toml"><img src="https://img.shields.io/badge/package%20manager-uv-success?logo=uv" alt="uv"/></a>
24+
<a href="https://github.com/martinmoldrup/toolit"><img src="https://img.shields.io/badge/command%20runner-toolit-success" alt="toolit"/></a>
2425
</p>
2526

2627
---

0 commit comments

Comments
 (0)