Adopt cargo orthohelp release help#288
Draft
lodyai[bot] wants to merge 17 commits into
Draft
Conversation
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![codescene-delta-analysis[bot]](https://avatars.githubusercontent.com/in/53921?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
lodyai
Bot
force-pushed
the
cargo-orthohelp-adoption
branch
from
f669b09 to
99e3f3c
Compare
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Document the approved-design boundary for replacing build-script help generation with explicit `cargo orthohelp` release workflow steps. Capture release artefact paths, test coverage expectations, documentation updates, risks, tolerances, and the approval gate before implementation.
Make the `MDLINT` default fall back to Bun's installation path when `markdownlint-cli2` is not present on `PATH`. This keeps `make markdownlint` working from sparse hook environments without changing interactive overrides.
Mark the cargo orthohelp adoption ExecPlan as approved and in progress so implementation can proceed against the live plan.
Introduce a release helper that calls `cargo orthohelp` for man pages and Windows PowerShell help, with rstest coverage around success and failure paths.
Replace build-script man-page generation with an explicit release helper that invokes `cargo orthohelp` for man pages and Windows PowerShell help. Keep `build.rs` focused on the localization audit and remove the `clap_mangen` build dependency. Wire release workflows and staging to consume `target/orthohelp` outputs, including staged Linux man pages and Windows PowerShell help sidecars. Add `rstest` contract tests and `rstest-bdd` scenarios covering successful release help generation, missing outputs, invalid `SOURCE_DATE_EPOCH`, and removal of the old build-script paths.
Keep the `CARGO` Makefile variable overrideable, but resolve it through `command -v` with a `$HOME/.cargo/bin/cargo` fallback. This lets non-login hook environments run `make check-fmt lint` when Cargo is not present on `PATH`. Record the hook finding and decision in the cargo-orthohelp ExecPlan.
Expose `make typecheck` as a warning-denying `cargo check` wrapper across all targets and features. This gives the post-rebase validation set a stable Makefile target alongside `check-fmt`, `test`, and `lint`. Record the rebase result and validation-target decision in the cargo-orthohelp ExecPlan.
Owner
|
@coderabbitai Please investigate the cause of the following issue using codegraph exploration and research, identify a fix and provide an AI coding agent prompt for the fix: |
Update the orthohelp ExecPlan with the latest successful rebase onto `origin/main`, including the absence of conflicts and the new config precedence work now present on the branch. Remove the extra blank line in the users guide so the rebased branch passes Markdown linting.
lodyai
Bot
force-pushed
the
cargo-orthohelp-adoption
branch
from
7d79b22 to
4335334
Compare
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as resolved.
This comment was marked as resolved.
Call `cargo-orthohelp` from the release-help script instead of using Cargo external subcommand dispatch, which injects an unsupported `orthohelp` positional argument. Update the release-help script tests to fake `cargo-orthohelp` directly and record the invocation decision in the orthohelp ExecPlan.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Owner
|
@coderabbitai Please investigate the cause of the following issue using codegraph exploration and research, identify a fix and provide an AI coding agent prompt for the fix: |
Owner
|
@coderabbitai Please investigate the cause of the following issue using codegraph exploration and research, identify a fix and provide an AI coding agent prompt for the fix: |
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
Use `render_captured` for manifest macro state retention so newer MiniJinja releases compile cleanly with warnings denied.
Owner
|
@coderabbitai will the clap_mangen flow still be supported after this change? If not, please ensure that the instructions give the option of using the clap_mangen flow where |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as resolved.
This comment was marked as resolved.
Keep manifest macro examples and safety notes aligned with `Template::render_captured`, which replaces the deprecated `eval_to_state` API in MiniJinja. Avoid an unfulfilled Clippy expectation on the macro state guard so the strict warning policy remains clean.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Pin Netsuke workflows to the shared-actions commit that adds `skip-man-page-discovery` and pass the opt-out to the `rust-build-release` call. Extend the build-and-package workflow test so every `rust-build-release` step must opt out of embedded man-page discovery while release help remains generated under `target/orthohelp`.
Pin every `leynos/shared-actions` workflow reference to `67025f53e79b821327d2f4d48a2af488cca42803` so CI, packaging, and release jobs use the same shared action revision.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Owner
|
@coderabbitai Please suggest a fix for this issue and supply a prompt for an AI coding agent to enable it to apply the fix. Include the file and symbol names indicated in the issue at the head of your response. tests/workflow_build_and_package.rs Comment on lines +41 to +64 fn rust_build_release_step_blocks(contents: &str) -> Vec<String> {
let mut blocks = Vec::new();
let mut current_block = Vec::new();
for line in contents.lines() {
if line.starts_with(" - ") && !current_block.is_empty() {
let block = current_block.join("\n");
if block.contains("rust-build-release@") {
blocks.push(block);
}
current_block.clear();
}
current_block.push(line);
}
if !current_block.is_empty() {
let block = current_block.join("\n");
if block.contains("rust-build-release@") {
blocks.push(block);
}
}
blocks
}❌ New issue: Bumpy Road Ahead |
This comment was marked as resolved.
This comment was marked as resolved.
Owner
|
@coderabbitai are the cargo orthohelp generated manpage and MAML help correctly bundled in the Linux .deb/.rpm packages and Windows .msi respectively? |
This comment was marked as resolved.
This comment was marked as resolved.
Move the repeated rust-build-release step block flush logic into a small helper so the workflow contract test keeps the same behaviour with less nested conditional logic.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Add the release staging configuration consumed by the shared staging action so Linux and macOS targets publish the generated man page and Windows targets upload PowerShell help sidecars. Teach GoReleaser to gzip the orthohelp man page when a pre-staged copy is not already present, and extend workflow/staging contract tests for the generated help outputs.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Owner
|
@coderabbitai re:
Is this something we should add to shared-actions? If so, please provide a detailed agent prompt for support of this for an agent working in the |
Contributor
|
Tip For best results, initiate chat on the files or code changes. 🧩 Analysis chain🏁 Script executed: Length of output: 49558
What |
Update shared-action pins to the revision that exposes `powershell_help_dir` from `stage-release-artefacts`. Wire Netsuke's Windows staging through `ps-module-name` and stage the PowerShell sidecar module at the module directory root so downstream steps can consume the new output without passing it into `windows-package`.
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
This branch carries the pre-implementation plan for adopting
cargo orthohelpas Netsuke's release help generator. It documents how the release workflow should replaceclap_mangenand the currentbuild.rsman-page output with explicit generation of Unix manual pages and Windows PowerShell MAML help.Execplan: docs/execplans/cargo-orthohelp-adoption.md
This branch also updates Makefile so
make markdownlintcan resolve the Bun-installedmarkdownlint-cli2in sparse hook environments where~/.bun/binis not onPATH.This is a pre-implementation planning PR. It does not authorize implementation until the execplan is approved.
Review walkthrough
MDLINTfallback keeps the existing override behaviour while fixing hook environments with a sparsePATH.Validation
make check-fmt: passed.make lint: passed.make test: passed.make markdownlint: passed.PATH=/usr/bin:/bin make markdownlint: passed.mbake validate Makefile: passed.Notes
No roadmap task or issue reference was found in the branch context. The execplan records that implementation must wait for explicit approval.