Skip to content

Commit 0b49c43

Browse files
committed
Prepare release 7.0.0
1 parent bf8fa45 commit 0b49c43

File tree

4 files changed

+31
-28
lines changed

4 files changed

+31
-28
lines changed

docs/docs/changelog/changes_7.0.0.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# 7.0.0 - 2024-04-19
2+
3+
## 🚨 Breaking Changes
4+
5+
### Update of crc configurations
6+
- **Rename:** The `Crc16.CCITT` configuration to `Crc16.XMODEM`.
7+
- **New Addition:** Introduced `Crc16.KERMIT`, which matches the official configuration for `Crc16.CCITT`.
8+
9+
#### Decision Rationale
10+
It was intentionally decided not to reintroduce `Crc16.CCITT` with the updated configuration. While it could have been added as an alias for `Crc16.KERMIT` or a replacement, omitting `Crc16.CCITT` ensures that client code will break upon update, thereby forcing maintainers to take notice and react accordingly.
11+
12+
#### Migration Guide
13+
Below are solutions to the two common scenarios that need to be addressed due to this change:
14+
15+
1. **If you previously used `Crc16.CCITT` and expected the configuration defined [here](https://reveng.sourceforge.io/crc-catalogue/all.htm#crc.cat.crc-16-kermit):**
16+
17+
**Solution:** Replace all usages of `Crc16.CCITT` in your code with `Crc16.KERMIT`.
18+
19+
2. **If you depended on or wanted to use the configuration values that `Crc16.CCITT` provided so far:**
20+
21+
**Solution:** Replace all usages of `Crc16.CCITT` in your code with `Crc16.XMODEM`.
22+
23+
#### Related Issues
24+
- [#148](https://github.com/Nicoretti/crc/issues/148)
25+
- [#145](https://github.com/Nicoretti/crc/issues/145)
26+
27+
## 🔩 Internal
28+
* Update `python-environment` action
29+
* Add classifiers to `pyproject.toml`

docs/docs/changelog/unreleased.md

-27
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,2 @@
11
# Unreleased
22

3-
## 🚨 Breaking Changes
4-
5-
### Update of crc configurations
6-
- **Rename:** The `Crc16.CCITT` configuration to `Crc16.XMODEM`.
7-
- **New Addition:** Introduced `Crc16.KERMIT`, which matches the official configuration for `Crc16.CCITT`.
8-
9-
#### Decision Rationale
10-
It was intentionally decided not to reintroduce `Crc16.CCITT` with the updated configuration. While it could have been added as an alias for `Crc16.KERMIT` or a replacement, omitting `Crc16.CCITT` ensures that client code will break upon update, thereby forcing maintainers to take notice and react accordingly.
11-
12-
#### Migration Guide
13-
Below are solutions to the two common scenarios that need to be addressed due to this change:
14-
15-
1. **If you previously used `Crc16.CCITT` and expected the configuration defined [here](https://reveng.sourceforge.io/crc-catalogue/all.htm#crc.cat.crc-16-kermit):**
16-
17-
**Solution:** Replace all usages of `Crc16.CCITT` in your code with `Crc16.KERMIT`.
18-
19-
2. **If you depended on or wanted to use the configuration values that `Crc16.CCITT` provided so far:**
20-
21-
**Solution:** Replace all usages of `Crc16.CCITT` in your code with `Crc16.XMODEM`.
22-
23-
#### Related Issues
24-
- [#148](https://github.com/Nicoretti/crc/issues/148)
25-
- [#145](https://github.com/Nicoretti/crc/issues/145)
26-
27-
## 🔩 Internal
28-
* Update `python-environment` action
29-
* Add classifiers to `pyproject.toml`

docs/mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ nav:
2525
- "development/release.md"
2626
- Changelog:
2727
- "changelog/unreleased.md"
28+
- "changelog/changes_7.0.0.md"
2829
- "changelog/changes_6.1.2.md"
2930
- "changelog/changes_6.1.1.md"
3031
- "changelog/changes_6.1.0.md"

pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "crc"
3-
version = "6.1.2"
3+
version = "7.0.0"
44
description = "Library and CLI to calculate and verify all kinds of CRC checksums"
55
packages = [
66
{ include = "crc", from = "src" },

0 commit comments

Comments
 (0)