Skip to content

docs(rust): say that publishOrder turns off the crate dependency sort - #787

Merged
goosewobbler merged 3 commits into
mainfrom
docs/rust-publish-order-unlisted
Oct 24, 2026
Merged

goosewobbler merged 3 commits into
mainfrom
docs/rust-publish-order-unlisted

Conversation

@goosewobbler

@goosewobbler goosewobbler commented Oct 24, 2026 •

Copy link
Copy Markdown
Owner

Description

docs/rust.md's "Publish ordering" section said crates missing from publish.cargo.publishOrder are "appended after in auto-sorted order". They aren't: setting publishOrder turns off the path-dependency sort, and the crates it doesn't list follow in discovery order. The option's table row in the same file already says this.

The note now says that setting publishOrder turns off the sort, so you should list every crate in a path dependency, dependencies first. A crate left off the list could otherwise publish before its path dependency.

Related Issue(s)

None; found while reviewing #765, whose per-package ordering matches batch mode here.

Type of Change

  • feat — New feature
  • fix — Bug fix
  • docs — Documentation change
  • refactor — Code refactoring
  • test — Adding or updating tests
  • chore — Maintenance, dependencies, tooling
  • Breaking change — Requires major version bump

Scope

  • @releasekit/version
  • @releasekit/notes
  • @releasekit/publish
  • @releasekit/release
  • @releasekit/config
  • @releasekit/core
  • CI / workflows
  • Root / monorepo

Checklist

  • Lint passes (pnpm lint)
  • Tests pass (pnpm test)
  • Typecheck passes (pnpm typecheck)
  • Documentation updated (if applicable)
  • Breaking changes noted in description: none

Testing Notes

Docs only. Checked against orderCrates in packages/publish/src/registry/cargo.ts: with an explicit order, the listed crates come first, then the rest in the order they were found, with no topological sort.

🤖 Generated with Claude Code

Setting cargo.publishOrder turns off the path-dependency sort, so crates
it doesn't list are published in discovery order, not auto-sorted. The
option's table row already said so.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Oct 24, 2026 •

Copy link
Copy Markdown
Contributor

Standing release PR: #730 · v0.42.1 queued (4 packages) · open 6h 57m · ✅ ready to merge

Release Preview — v0.42.0 → v0.42.1

Note: Labels on this PR are advisory in standing-pr mode. Bumps come from conventional commits in the standing PR; override by editing labels on the standing PR itself. Add release:immediate to bypass the standing PR and release this PR directly.

These changes will be added to the release PR (#730) when merged:

Changelog

monorepo 0.42.0 → 0.42.1

Changed

  • shorten the publishOrder note (rust)
  • split the publishOrder note into one point per sentence (rust)
  • crates missing from publishOrder keep discovery order (rust)

All packages → 0.42.1 (sync versioning)

  • @releasekit/version
  • @releasekit/notes
  • @releasekit/publish
  • @releasekit/release

After merge — predicted release

No version escalation — this PR's changes will be included in the queued release without affecting the projected versions.

Package Standing PR This PR After merge
monorepo 0.42.1 0.42.1 0.42.1

Updated automatically by ReleaseKit

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@goosewobbler goosewobbler changed the title docs(rust): crates missing from publishOrder keep discovery order docs(rust): say that publishOrder replaces the crate dependency sort Oct 24, 2026
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@goosewobbler goosewobbler changed the title docs(rust): say that publishOrder replaces the crate dependency sort docs(rust): say that publishOrder turns off the crate dependency sort Oct 24, 2026
@goosewobbler
goosewobbler merged commit b8d02cb into main Oct 24, 2026
18 checks passed
@goosewobbler
goosewobbler deleted the docs/rust-publish-order-unlisted branch October 24, 2026 01:26
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