feat(common): describe paths and platform helpers in crate description#3498
Merged
Merged
Conversation
Align the package `description` and the lib.rs crate-level doc with the modules now exposed from `ironclaw_common` (paths, platform, env_helpers, attachment), which #3387 lifted out of `src/`. The previous wording predates that extraction and only mentioned "types and utilities". This is also the release-plumbing trigger for v0.28.1: release-plz proposes a leaf bump on source-path changes, and once `ironclaw_common` crosses to a new patch, the root `ironclaw` bump can be added on top of the release-plz branch (same approach as commit 9e69f22 for v0.28.0). See PR #3372 for the equivalent v0.28.0 trigger. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
github-actions
Bot
added
size: XS
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the description in Cargo.toml and the module documentation in lib.rs for the ironclaw_common crate to include references to paths and platform helpers. There are no review comments to address, and I have no further feedback to provide.
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two-line text change in
crates/ironclaw_common:Cargo.tomldescription:Shared types and utilities used across the IronClaw workspace→Shared types, paths, and platform helpers used across the IronClaw workspacesrc/lib.rscrate-level doc comment: same wording, kept in lockstepThe previous wording predates #3387, which lifted
paths,platform,env_helpers, andattachmentout ofsrc/and into this crate. The description now matches what the crate actually exposes, and Cargo.toml + lib.rs stay aligned (the invariant #3372 was about).Why
feat:for a wording changeSame release-plumbing reason as #3372: release-plz only proposes a release when a leaf crate has source-path changes since its last tag.
Last release cut at #3376 / commit
9e69f22d2bumpedironclaw_common 0.4.0 → 0.4.1and rootironclaw 0.27.0 → 0.28.0. release-plz then opened PR #3388 proposingironclaw_common 0.4.1 → 0.4.2(cargo-semver-checks marked the #3387 surface "API compatible", so no root cascade — same shape as last time).This PR adds another
feat(common):source-path change so the next release-plz cycle picks it up alongside #3387. Once merged, the rootironclaw 0.28.0 → 0.28.1bump and a[0.28.1]CHANGELOG.mdentry will be added on top of the release-plz branch manually — mirroring commit9e69f22d2from the v0.28.0 cut.A more durable fix (e.g.
release_always = trueon theironclawpackage inrelease-plz.toml) is a separate conversation; this PR only unblocks the v0.28.1 cut.Test plan
chore: releasePR proposingironclaw_common 0.4.1 → 0.4.2ironclaw 0.28.0 → 0.28.1bump +CHANGELOG.md [0.28.1]entry on that release-plz branch, mirroring9e69f22d2ironclaw-v0.28.1tag → cargo-dist fires🤖 Generated with Claude Code