Skip to content

Keep the documented downstream replacement set synchronized with go.mod #18

Description

@Vonng

Summary

The README says downstream embedders must adopt the matching SILO replacement set, but the example is stale.

README currently shows:

  • MCLI commit 70a2950;
  • silo-pkg v3.12.2.

Current go.mod selects:

  • MCLI commit 5ed037e;
  • silo-pkg compatibility commit 748c94b.

Impact

Go does not propagate replacement directives from dependency modules. A server following the documented example therefore builds a different graph and misses the fixes this Console release is intended to consume.

This inconsistency was introduced by the post-v2.2.1 dependency updates.

Acceptance criteria

  • Update the README example to the final released dependency set chosen for the next release.
  • Ensure comments in go.mod, README, and CHANGELOG describe the same supported combinations.
  • Add a CI check that compares the documented replacement block with the effective go.mod replacements, or generate the block from one source of truth.
  • Test the copied README block in a minimal downstream embedder module.
  • Explicitly document unsupported partial-override graphs.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/releaseRelease process and versioningdocumentationImprovements or additions to documentationpriority/blockerMust be resolved before the next release

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions