Merge pull request #109 from nspcc-dev/rel-0.2.0

CHANGELOG: release 0.2.0

.github/workflows/changelog_update.yml

@@ -0,0 +1,28 @@
+name: CHANGELOG check
+
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Check for updates
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Get changed CHANGELOG
+        id: changelog-diff
+        uses: tj-actions/changed-files@v44
+        with:
+          files: CHANGELOG.md
+
+      - name: Fail if changelog not updated
+        if: steps.changelog-diff.outputs.any_changed == 'false'
+        uses: actions/github-script@v7
+        with:
+          script: |
+            core.setFailed('CHANGELOG.md has not been updated')

CHANGELOG.md

@@ -6,6 +6,28 @@ This document outlines major changes between releases.
 
 New features:
 
+Behaviour changes:
+
+Improvements:
+
+Bugs fixed:
+
+## [0.2.0] (01 April 2024)
+
+We're rolling out an update for dBFT that contains a substantial library interface
+refactoring. Starting from this version dBFT is shipped as a generic package with
+a wide range of generic interfaces, callbacks and parameters. No default payload
+implementations are supplied anymore, the library itself works only with payload
+interfaces, and thus users are expected to implement the minimum required set of
+payload interfaces by themselves. A lot of outdated and unused APIs were removed,
+some of the internal APIs were renamed, so that the resulting library interface
+is much more clear and lightweight. Also, the minimum required Go version was
+upgraded to Go 1.20.
+
+Please note that no consensus-level behaviour changes introduced, this release
+focuses only on the library APIs improvement, so it shouldn't be hard for the users
+to migrate to the new interface.
+
 Behaviour changes:
  * add generic Hash/Address parameters to `DBFT` service (#94)
  * remove custom payloads implementation from default `DBFT` service configuration
@@ -15,6 +37,7 @@ Behaviour changes:
  * move all default implementations to `internal` package (#97)
  * remove unused APIs of dBFT and payload interfaces (#104)
  * timer interface refactoring (#105)
+ * constructor returns some meaningful error on failed dBFT instance creation (#107)
 
 Improvements:
  * add MIT License (#78, #79)
@@ -25,11 +48,10 @@ Improvements:
  * untie `dbft` module from `github.com/nspcc-dev/neo-go` dependency (#94)
  * minimum required Go version upgrade to Go 1.20 (#100)
 
-Bugs fixed:
-
 ## [0.1.0] (15 May 2023)
 
 Stable dbft 2.0 implementation.
 
-[Unreleased]: https://github.com/nspcc-dev/dbft/compare/v0.1.0...master
+[Unreleased]: https://github.com/nspcc-dev/dbft/compare/v0.2.0...master
+[0.2.0]: https://github.com/nspcc-dev/dbft/releases/v0.2.0
 [0.1.0]: https://github.com/nspcc-dev/dbft/releases/v0.1.0