Radish alpha
r
Radicle CI broker
Radicle
Git (anonymous pull)
Log in to clone via SSH
docs(NEWS.md): update release notes for upcoming release
Lars Wirzenius committed 1 year ago
commit 8da1598d2f8e3570429d94372988be6a3d450c6a
parent ab23fd0f8e0586d9dada3c017d5aded6cacb8134
1 file changed +26 -2
modified NEWS.md
@@ -1,4 +1,4 @@
-
# Release notes about `radicle-ci-broker`
+
# Release notes for `radicle-ci-broker`

This file summarizes the user-visible changes to `radicle-ci-broker`
between releases.
@@ -13,8 +13,26 @@ This is the third release. It breaks all existing installations.
* The CI broker now parses Git ref names for node identifiers more
  correctly.

+
* When the node sends an event about a branch having changed, the CI
+
  broker now allows the branch name to have slashes.
+

### New or changed features

+
* The `ci-broker` program has been replaced with the `cib` program,
+
  which is better in a few ways. Most importantly, it persists the
+
  node events that need to be processed, in a queue, so that they are
+
  not lost when the CI broker is re-started. The persistent storage is
+
  in the form of an SQLite database file: `ci-broker` used it already,
+
  but `cib` puts more information in it. There is also a list of all
+
  CI runs `cib` has performed.
+

+
* The `cibtool` program has been added to allow the node operator to
+
  manage `cib`, via the SQLite database file. `cibtool` lets the
+
  operator to view and manipulate the node event queue, and the list
+
  of CI runs, and to generate HTML report pages from information in
+
  the database. (`cib` generates the same report pages when running:
+
  `cibtool` functionality is there just in case.)
+

* CI broker logging continues to be inconsistent and helpful mainly to
  those developing the CI broker itself. Some logging has been
  removed, to avoid so called logspam.
@@ -32,7 +50,13 @@ This is the third release. It breaks all existing installations.

* The acceptance criteria for the CI broker are now documented in more
  detail in the subplot (see `ci-broker.md` and the
-
  [Subplot](https://subplot.tech/) software).
+
  [Subplot](https://subplot.tech/) software). The subplot document is
+
  available as
+
  [HTML](https://pages.radicle.liw.fi/ci-broker/ci-broker.html).
+

+
* Various undocumented helper programs have been dropped from the CI
+
  broker. Their functionality, if needed, can be added to `cibtool` in
+
  the future.


## Version 0.2.0, released 2024-06-06