Prepare release 7.0.0

Nicoretti · Apr 19, 2024 · 0b49c43 · 0b49c43
1 parent bf8fa45
commit 0b49c43
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 28 deletions.
diff --git a/docs/docs/changelog/changes_7.0.0.md b/docs/docs/changelog/changes_7.0.0.md
@@ -0,0 +1,29 @@
+# 7.0.0 - 2024-04-19 
+
+## 🚨 Breaking Changes
+
+### Update of crc configurations
+- **Rename:** The `Crc16.CCITT` configuration to `Crc16.XMODEM`.
+- **New Addition:** Introduced `Crc16.KERMIT`, which matches the official configuration for `Crc16.CCITT`.
+
+#### Decision Rationale
+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.
+
+#### Migration Guide
+Below are solutions to the two common scenarios that need to be addressed due to this change:
+
+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):**
+
+      **Solution:** Replace all usages of `Crc16.CCITT` in your code with `Crc16.KERMIT`.
+
+2. **If you depended on or wanted to use the configuration values that `Crc16.CCITT` provided so far:**
+
+      **Solution:** Replace all usages of `Crc16.CCITT` in your code with `Crc16.XMODEM`.
+
+#### Related Issues
+- [#148](https://github.com/Nicoretti/crc/issues/148)
+- [#145](https://github.com/Nicoretti/crc/issues/145)
+
+## 🔩  Internal
+* Update `python-environment` action
+* Add classifiers to `pyproject.toml`
diff --git a/docs/docs/changelog/unreleased.md b/docs/docs/changelog/unreleased.md
@@ -1,29 +1,2 @@
 # Unreleased
 
-## 🚨 Breaking Changes
-
-### Update of crc configurations
-- **Rename:** The `Crc16.CCITT` configuration to `Crc16.XMODEM`.
-- **New Addition:** Introduced `Crc16.KERMIT`, which matches the official configuration for `Crc16.CCITT`.
-
-#### Decision Rationale
-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.
-
-#### Migration Guide
-Below are solutions to the two common scenarios that need to be addressed due to this change:
-
-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):**
-
-      **Solution:** Replace all usages of `Crc16.CCITT` in your code with `Crc16.KERMIT`.
-
-2. **If you depended on or wanted to use the configuration values that `Crc16.CCITT` provided so far:**
-
-      **Solution:** Replace all usages of `Crc16.CCITT` in your code with `Crc16.XMODEM`.
-
-#### Related Issues
-- [#148](https://github.com/Nicoretti/crc/issues/148)
-- [#145](https://github.com/Nicoretti/crc/issues/145)
-
-## 🔩  Internal
-* Update `python-environment` action
-* Add classifiers to `pyproject.toml`
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -25,6 +25,7 @@ nav:
       - "development/release.md"
   - Changelog:
       - "changelog/unreleased.md"
+      - "changelog/changes_7.0.0.md"
       - "changelog/changes_6.1.2.md"
       - "changelog/changes_6.1.1.md"
       - "changelog/changes_6.1.0.md"

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "crc"
-version = "6.1.2"
+version = "7.0.0"
 description = "Library and CLI to calculate and verify all kinds of CRC checksums"
 packages = [
     { include = "crc", from = "src" },