fix(ci-broker.md): drop unused embedded file shutdown.json

Signed-off-by: Lars Wirzenius <liw@liw.fi>
This commit is contained in:
Lars Wirzenius
2024-07-17 18:49:23 +03:00
parent a2f223c8a7
commit ab23fd0f8e
2 changed files with 31 additions and 21 deletions
+31
View File
@@ -4,6 +4,37 @@ This file summarizes the user-visible changes to `radicle-ci-broker`
between releases. between releases.
## Version 0.3.0, released 2024-07-xx
This is the third release. It breaks all existing installations.
### Bug fixes
* The CI broker now parses Git ref names for node identifiers more
correctly.
### New or changed features
* 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.
* The code has been refactored a lot, for simplicity. This should be
invisible to others, especially the adapter implementations, but
just in case, be aware something externally visible may have changed
inadvertently.
* The `BrokerEvent::is_allowed` method is no longer exposed in the CI
broker public API. If you need it, let us know.
* The CI broker now logs the executable filename of the adapter it
runs.
* 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).
## Version 0.2.0, released 2024-06-06 ## Version 0.2.0, released 2024-06-06
This is the second release. This is the second release.
-21
View File
@@ -73,27 +73,6 @@ changed in repository.
} }
~~~ ~~~
## A shutdown event
This asks the CI broker to shut down cleanly.
~~~{#shutdown.json .file .json}
{
"type": "refsFetched",
"remote": "z6MkgEMYod7Hxfy9qCvDv5hYHkZ4ciWmLFgfvm3Wn1b2w2FV",
"rid": "rad:zwTxygwuz5LDGBq255RA2CbNGrz8",
"updated": [
{
"skipped": {
"name": "shutdown",
"oid": "0000000000000000000000000000000000000000"
}
}
]
}
~~~
## Set rid in `refsFetched` event ## Set rid in `refsFetched` event
This is a helper script that reads a `refsFetched` event and changes This is a helper script that reads a `refsFetched` event and changes