Rename the application crate to netsuke-build - #523
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
Summary
WalkthroughChangesThe Cargo package is renamed to Package identity and installation alignment
Possibly related PRs
Suggested reviewers: Poem
Caution Pre-merge checks failedPlease resolve all errors before merging. Addressing warnings is optional.
❌ Failed checks (2 errors, 2 warnings, 2 inconclusive)
✅ Passed checks (14 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
Reviewer's GuideRenames the published crates.io package from File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 4b7c7b4f1e
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
@coderabbitai Have the following failed checks now been resolved? If further work is required, please provide an AI agent prompt for the remaining work to be done to address these failures. Do not treat warnings as optional or aspirational. Where a change is out of scope for this PR, propose a GitHub issue unless one exists already. (Treat o11y, code safety, documentation and validation coverage as in scope). Developer Documentation |
This comment was marked as resolved.
This comment was marked as resolved.
Publish the Cargo package as `netsuke-build` while preserving `netsuke` as the library target, command, manual page, release artefact, and operating- system package name. Update registry installation guidance and its contract tests to use the new crates.io package name.
Add `[package.metadata.binstall]` overrides so `cargo binstall netsuke-build` resolves the release assets, which are named after the `netsuke` binary rather than the Cargo package. Without them cargo-binstall would search for `netsuke-build`-prefixed assets, find none, and fall back to the source build on the pinned nightly that the documented command exists to avoid. Publish the manual page path `build.rs` writes through `cargo:rustc-env` and add a contract test that asserts the page is named for the command-line interface name, is staged under `target/generated-man/<target>/<profile>/`, and carries a `.TH` source that never mentions the package name. Add a contract test that rebuilds the expected binstall asset names from `.github/release-staging.toml` and checks the override set against the release workflow's target matrix. Record the rename in ADR-007 and document the package-versus-target naming rule in the developer guide. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The entity-aware merge driver consumed the blank line separating the `[[bin]]` target from `[package.metadata.ortho_config]` when it interleaved the target declarations with the expanded locale list. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2b7087c to
375c6be
Compare
Summary
This branch renames the crates.io package from
netsuketonetsuke-buildbecause the original crate name is unavailable. It preserves Netsuke branding,
the
netsukecommand and library target, manual pages, release artefacts, andoperating-system package names.
It also updates crates.io installation guidance and the contracts that verify
package selection, installation commands, CLI help, and packaging smoke tests.
Review walkthrough
Start with Cargo.toml for the new package name and preserved
netsukelibrary and binary targets.Review build.rs and src/cli/parser.rs for the preserved command and manual-page branding.
Check README.md and docs/users-guide.md for the updated crates.io installation commands.
Then tests/documentation_examples_tests.rs and tests/packaging_smoke_tests.rs for the installation and publication contracts.
Review Cargo.toml
[package.metadata.binstall]overrides, which pointcargo binstall netsuke-buildat the release assets named after thenetsukebinary.Read docs/adr-007-publish-as-netsuke-build.md and the "Package and target naming" section of docs/developers-guide.md for the recorded decision and the day-to-day rule.
Finish with tests/man_page_contract_tests.rs and tests/binstall_metadata_tests.rs, which pin the generated manual page and the binstall overrides.
Validation
make check-fmt: passedmake lint: passedmake typecheck: passedmake test: passed (1,364 root tests, 39 test-support tests, and all doctests)make markdownlint: passedmake nixie: passedmbake validate Makefile: passedReferences
Summary by Sourcery
Rename the crates.io package to
netsuke-buildwhile preserving thenetsukelibrary and binary targets and aligning tooling and documentation with the new package name.Enhancements:
netsuke-buildcrates.io package name and thenetsuketargets in the repository layout guide.Documentation:
netsuke-buildfor crates.io and binstall installation commands and examples.Tests:
netsuke-buildpackage name instead ofnetsuke.Chores:
netsuke-buildpackage while keeping thenetsukebinary name exposed to users.