Documentation.
Hi team,
I wanted to flag an issue we ran into with the v2.7.0 release of eigenda-proxy, and share a request for how this could be handled going forward.
In this release, some CLI flags were removed without being fully documented in the release notes. While the notes mention the removal of several --node.* flags, they don't mention the removal of -eigenda.* flags (for example, -eigenda.disperser-rpc):
https://github.com/Layr-Labs/eigenda/pull/2481/changes#diff-de217d00b249f7f715f1a8734a3d1d0a9e097c0b62b32ea58fc724a8bfc4e44cL34
From an operator perspective, CLI flags are part of the public interface. When they're removed without documentation or a major version bump, it can lead to unexpected issues during routine upgrades—especially for setups using version ranges like ~2.x or automated updates.
According to https://semver.org/, removing or changing existing functionality in a backwards-incompatible way is considered a breaking change and should be reflected in a major version bump.
Going forward, it would be really helpful if:
All removed or renamed CLI flags are documented in the release notes (even if they're considered legacy)
Breaking changes like this are reserved for major version bumps, in line with semantic versioning
A short migration guide is included when flags are removed or renamed (old flag, replacement if any, and required action)
If strict semver isn't the intent, that's clarified in the README so operators can plan accordingly
Appreciate all the work on the project—these changes would make upgrades much more predictable and safer to operate.
Thanks
Additional information.
No response
Documentation.
Hi team,
I wanted to flag an issue we ran into with the v2.7.0 release of eigenda-proxy, and share a request for how this could be handled going forward.
In this release, some CLI flags were removed without being fully documented in the release notes. While the notes mention the removal of several --node.* flags, they don't mention the removal of -eigenda.* flags (for example, -eigenda.disperser-rpc):
https://github.com/Layr-Labs/eigenda/pull/2481/changes#diff-de217d00b249f7f715f1a8734a3d1d0a9e097c0b62b32ea58fc724a8bfc4e44cL34
From an operator perspective, CLI flags are part of the public interface. When they're removed without documentation or a major version bump, it can lead to unexpected issues during routine upgrades—especially for setups using version ranges like ~2.x or automated updates.
According to https://semver.org/, removing or changing existing functionality in a backwards-incompatible way is considered a breaking change and should be reflected in a major version bump.
Going forward, it would be really helpful if:
All removed or renamed CLI flags are documented in the release notes (even if they're considered legacy)
Breaking changes like this are reserved for major version bumps, in line with semantic versioning
A short migration guide is included when flags are removed or renamed (old flag, replacement if any, and required action)
If strict semver isn't the intent, that's clarified in the README so operators can plan accordingly
Appreciate all the work on the project—these changes would make upgrades much more predictable and safer to operate.
Thanks
Additional information.
No response