Skip to content

Document dependency versions without duplicating current requirements. - #40

Merged
samuel-williams-shopify merged 1 commit into
mainfrom
docs/dependency-version-guidance
Oct 6, 2026
Merged

samuel-williams-shopify merged 1 commit into
mainfrom
docs/dependency-version-guidance

Conversation

@samuel-williams-shopify

Copy link
Copy Markdown
Contributor

Document how to maintain dependency versions in installation examples and compatibility guidance. Publish the shared guidelines in socketry-project 0.3.11.

Installation examples prefer Cargo commands that select a dependency and write its manifest requirement. Manifests and lockfiles remain authoritative for supported requirements and resolved selections, while explicit numeric references continue to explain compatibility boundaries, historical changes, migration steps, and reproducible examples. The guidelines also cover manifest examples and generating repeated version references from metadata.

The setup and release guides now direct readers to the resolved task provider's manifest instead of repeating provider-version lists. The release guide distinguishes that installed provider from the current source manifest and uses cargo metadata --locked to locate it.

@samuel-williams-shopify
samuel-williams-shopify merged commit 69162d4 into main Oct 6, 2026
4 checks passed
@samuel-williams-shopify
samuel-williams-shopify deleted the docs/dependency-version-guidance branch October 6, 2026 01:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant