Add CHANGELOG entry and README install section for the prometheus-io rename - #801
Conversation
|
This is still showing the commits twice. That's unexpected behavior. Also #782 needs to land. There are further tasks that need to be completed AFTER that lands in order to be able to publish and we are making it the tall tent pole to shipping by being precious about not merging it. Please approve. |
Record the package rename under Breaking, including the cluster and worker thread IPC message type rename, and add an installation section to the README so the new package name is discoverable. Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com> Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
f3787aa to
2d09a83
Compare
Force pushed @jdmarshall |
| - ci: switch out deprecated benchmark-regression library for replacement | ||
| - AggregatorRegistry renamed to ClusterRegistry, old name deprecated | ||
| - chore: update faceoff to 1.1 | ||
| - chore: update faceoff to 1.3 |
There was a problem hiding this comment.
Faceoff didn't even exist the last time this package was released. Strictly speaking, if faceoff warrants an entry at all it should be, "replaced benchmark-regression library with faceoff"
benchmark-regression is built on benchmark and both of them had serious issues with async functions and neither are being maintained. There's been a rash of async-hostile libraries simply going dark rather than wrestling with the design assumptions that make it a challenge to modify them to support async code. The other module I maintain also had that issue, and if it weren't for an 11th hour epiphany while preparing the next major version of that library, it would still be awkwardly bolted on to the side. It's going to take a second major release and relying on top-level async to make it fully integrated.
I created faceoff to be a drop-in, async replacement for benchmark-regression while exposing the more legible output of bench-node, which was created by someone on the NodeJS steering committee. And now for some reason I'm a maintainer on that project as well.
Stacked on top of #799 — this branch is based on
jdmarshall:prometheus-io, so until #799 merges the diff here also shows that PR's rename commit. Only the second commit (CHANGELOG.md,README.md) is new.#799 renames the package to
@prometheus-io/clientbut leaves the change unrecorded, which is why its Changelog Reminder check is red.Also update the readme with some install instructions.