Radish alpha
r
Radicle CI broker
Radicle
Git (anonymous pull)
Log in to clone via SSH
docs: add NEWS.md
Lars Wirzenius committed 1 year ago
commit 4f1036970c8c6d9729a3976fd420602da18cc04c
parent c82fc3f657d31c9e737bcbc96000cb6bb4c8ad79
1 file changed +73 -0
added NEWS.md
@@ -0,0 +1,73 @@
+
# Release notes about `radicle-ci-broker`
+

+
This file summarizes the user-visible changes to `radicle-ci-broker`
+
between releases.
+

+

+
## Version 0.2.0, released 2024-06-06
+

+
This is the second release.
+

+
### Bug fixes
+

+
* The CI broker now picks the newest commit in a patch or branch,
+
  rather than the oldest. This means changes to a patch or branch get
+
  processed by CI, rather than only the first version. (Lars
+
  Wirzenius)
+

+
* Error messages are a little clearer now. An unclear error message is
+
  a bug. (Lars Wirzenius)
+

+
* Problems with the adapter sub-process failing are handled better
+
  now. (Lars Wirzenius)
+

+
* If the CI broker loses its connection to the Radicle node, the
+
  broker now terminates. Previously, it would keep trying to receive a
+
  message from the broken connection, which it would never receive,
+
  since the connection was broken in a way that it would not be mended
+
  even if the node is restarted. Computers are very patient, and never
+
  give up hope, so the CI broker was willing to wait until the heat
+
  death of the universe, or a power outage, whichever came first.
+

+
  Now, something like `systemd` can be used to restart the CI broker
+
  if this happens, and the system will recover. (Lars Wirzenius)
+

+

+
### New or changed features
+

+
* The CI broker depend on the version of the `radicle` crate that
+
  corresponds to the Radicle (heartwood) version 1.0.0 release
+
  candidate 10. This makes it possible to use the CI broker with the
+
  current version of Radicle. (Lars Wirzenius)
+

+
* The adapter protocol now allows an adapter to give the CI broker a
+
  URL related to the CI run. This can be used to link to a build log,
+
  for example. (Lars Wirzenius)
+

+
* The node event filter now has an `AnyPushRef` condition. (Michalis
+
  Zampetakis)
+

+
* The CI broker architecture documentation is now published to
+
  <https://pages.radicle.liw.fi/ci-broker/architecture.html> by CI
+
  whenever the CI broker is changed. (Lars Wirzenius)
+

+
* The logging for event handling a lot more verbose. This is useful
+
  for debugging problems, but is otherwise so noisy logs become nearly
+
  useless. (Lars Wirzenius)
+

+
* The documentation for the broker/adapter protocol should be up to
+
  date. (Michalis Zampetakis)
+

+
* The CI broker configuration now has the `sensitive_envs` field to
+
  allow specifying environment variables that should not be logged.
+
  (Lars Wirzenius)
+

+
* The CI broker can now be shut down cleanly. This is mostly useful
+
  for testing, though, at least for now, but opens up the possibility
+
  of shutting down only after any in-progress CI runs having finished
+
  first. (Lars Wirzenius)
+

+

+
## Version 0.1.0, released 2024-04-03
+

+
This was the first release. No notes.