vinzenz/hyperhive
vinzenz/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

docs(#2671): trim per-verb arg help (pr-create, comments, ci-log, ci-rerun)

Browse source 
Drop implementation detail from the clap arg help (the `<verb> --help`
surface) — which API/endpoint, page-count math, persisted-vs-streamer
log-source internals, refspec shapes — keeping only what/when-to-use for
each flag. Module `//!` docs (dev-facing, not shown by `--help`) left
intact.
This commit is contained in:
atlas 2026-07-23 21:55:04 +02:00
commit ef9935e3d0
4 changed files with 24 additions and 39 deletions
Download patch file Download diff file Expand all files Collapse all files

20
hive-forge/src/verbs/ci_rerun.rs
View file

@ -35,23 +35,21 @@ use crate::client::{Client, index};
#[derive(ClapArgs)]
pub struct Args {
/// Re-run CI for this PR: resolves the PR's head branch and dispatches
/// `--workflow` on it. Mutually exclusive with `--run` / `--branch`.
/// Re-run CI for this PR (its head branch). Mutually exclusive with
/// `--run` / `--branch`.
#[arg(long, conflicts_with_all = ["run", "branch"])]
pr: Option<u64>,
/// Dispatch a fresh run of the workflow that produced this run, on the
/// same branch the run used. The run number is the `runs/<n>` in the
/// run-page URL — what `pr-status` surfaces as a CI context's
/// `target_url`. Mutually exclusive with `--pr` / `--branch`.
/// Re-run the same workflow on the same branch this run used. The run
/// number is the `runs/<n>` in the run-page URL. Mutually exclusive
/// with `--pr` / `--branch`.
#[arg(long, conflicts_with_all = ["pr", "branch"])]
run: Option<u64>,
/// Dispatch `--workflow` on this branch directly. Mutually exclusive
/// with `--pr` / `--run`.
/// Re-run `--workflow` on this branch. Mutually exclusive with
/// `--pr` / `--run`.
#[arg(long, conflicts_with_all = ["pr", "run"])]
branch: Option<String>,
/// Workflow file to dispatch for `--pr` / `--branch` (the file name under
/// `.forgejo/workflows/`). Ignored for `--run`, which resolves the
/// workflow from the run itself (falling back to this value).
/// Workflow file to run (default `ci.yml`). Ignored for `--run`,
/// which uses the run's own workflow.
#[arg(long, default_value = "ci.yml")]
workflow: String,
}