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

hive-forge: ci-rerun dispatches a fresh run via workflow-dispatch API

Browse source 
The previous implementation POSTed Forgejo's run-page rerun web route,
which is CSRF-gated and answers a bare token POST with 404 — so the verb
never actually re-ran anything against the agent token.

Rework it to dispatch a fresh run of the workflow via the
GitHub-compatible workflow-dispatch API
(POST /repos/<o>/<r>/actions/workflows/<workflow>/dispatches {"ref":<branch>}),
which accepts a plain agent token (verified end-to-end on Forgejo 15.0.3).
A dispatched run is equivalent to the old empty-commit retrigger, minus
the commit.

The branch is resolved from exactly one of --pr (the PR head branch),
--run (branch + workflow looked up from that run in the Actions runs
list), or --branch (directly); --workflow picks the workflow file for
--pr/--branch (default ci.yml). Dispatch re-runs the whole workflow, so
the old --job single-job variant is dropped.

Also add workflow_dispatch to .forgejo/workflows/ci.yml for explicitness
(Forgejo 15.0.3 dispatches the pull_request workflow without it, but the
trigger makes the API path intent-clear and cross-version robust), remove
the now-unused Client::post_web_no_content, and update docs/tools/forge.md.
This commit is contained in:
atlas 2026-06-23 11:25:33 +02:00 • committed by mara
commit c9c59c2a1d
4 changed files with 175 additions and 118 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,133 +1,202 @@
//! `ci-rerun --run <n> [--job <i>]` / `ci-rerun --pr <n>` — re-run a CI
//! Actions workflow run without pushing an empty commit.
//! `ci-rerun --pr <n>` / `ci-rerun --run <n>` / `ci-rerun --branch <name>`
//! — re-run CI without pushing an empty commit.
//!
//! When a run fails for a transient reason (a remote-builder flap, a
//! cold-daemon window, an `act_runner` hiccup) the only retrigger path used
//! to be an empty commit, which litters PR history. This verb POSTs the
//! rerun action directly.
//! to be an empty commit, which litters PR history.
//!
//! Forgejo exposes no REST endpoint for rerunning a run; the rerun buttons
//! on the run page hit web routes. Re-running all jobs is a POST to
//! `<base>/<owner>/<repo>/actions/runs/<n>/rerun`, and re-running one job a
//! POST to `<base>/<owner>/<repo>/actions/runs/<n>/jobs/<i>/rerun`.
//! Forgejo exposes no token-usable REST endpoint to *re-run an existing run*:
//! the run-page rerun buttons hit CSRF-gated web routes that a bare token
//! POST answers with `404`. Instead this verb dispatches a **fresh** run of
//! the workflow via the GitHub-compatible workflow-dispatch API,
//! `POST /repos/<owner>/<repo>/actions/workflows/<workflow>/dispatches` with
//! `{"ref": "<branch>"}`. That creates a brand-new run on the branch — the
//! same effect as the empty-commit trick, minus the commit — and accepts a
//! plain agent token (verified end-to-end on Forgejo 15.0.3, which dispatches
//! even a `pull_request`-only workflow).
//!
//! Both key off the per-repo run NUMBER (the `runs/<n>` the UI shows and
//! `pr-status` surfaces as a CI context `target_url`), so `--run` is used
//! directly with no id translation — same convention as `ci-log`. They
//! reply with a redirect to the run page rather than a body, so this drives
//! `Client::post_web_no_content`. The auth path matches `ci-log`'s web POST:
//! a token-authed doer, no `_csrf` needed.
//! The branch (and, for `--run`, the workflow file) is resolved from the
//! given handle:
//! - `--pr <n>` → the PR's head branch; dispatches `--workflow` (default
//! `ci.yml`) on it.
//! - `--branch <name>` → dispatches `--workflow` on that branch directly.
//! - `--run <n>` → looks the run up in the Actions runs list (by the
//! `runs/<n>` tail of its `html_url`, same convention as `ci-log` /
//! `artifact-get`) and dispatches the SAME workflow on the SAME branch the
//! run used.
//!
//! `--pr` is a convenience: it resolves the PR head sha's CI status and
//! pulls the run number out of the status `target_url`, then re-runs that
//! run's jobs.
//! Dispatch re-runs the whole workflow, so there is no single-job variant.
use anyhow::{Context as _, Result, bail};
use clap::Args as ClapArgs;
use serde_json::Value;
use serde_json::{Value, json};
use crate::client::Client;
#[derive(ClapArgs)]
pub struct Args {
/// Workflow run number — the `runs/<n>` in the run-page URL, which
/// `pr-status` surfaces as a CI context's `target_url`. Mutually
/// exclusive with `--pr`.
#[arg(long, conflicts_with = "pr")]
run: Option<u64>,
/// Re-run the latest run for this PR's head commit. Resolves the run
/// number from the head sha's CI status. Mutually exclusive with
/// `--run`.
#[arg(long)]
/// Re-run CI for this PR: resolves the PR's head branch and dispatches
/// `--workflow` on it. Mutually exclusive with `--run` / `--branch`.
#[arg(long, conflicts_with_all = ["run", "branch"])]
pr: Option<u64>,
/// Re-run only this job index (0-based). Omit to re-run every job in
/// the run.
#[arg(long)]
job: 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`.
#[arg(long, conflicts_with_all = ["pr", "branch"])]
run: Option<u64>,
/// Dispatch `--workflow` on this branch directly. 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).
#[arg(long, default_value = "ci.yml")]
workflow: String,
}
/// # Errors
///
/// Returns an error if neither `--run` nor `--pr` is given, if `--pr` can't
/// be resolved to a run number (no CI status on the head commit yet), or if
/// the rerun POST fails (network, or a non-2xx such as `404` for an unknown
/// run).
/// Returns an error if none of `--pr` / `--run` / `--branch` is given, if a
/// `--pr` / `--run` handle can't be resolved (unknown PR/run, or a run
/// missing its branch), or if the dispatch POST fails (network, or a non-2xx
/// such as `404` for an unknown workflow file or branch).
pub fn run(client: &Client, args: Args) -> Result<()> {
let repo = client.repo();
let run = match (args.run, args.pr) {
(Some(n), _) => n,
(None, Some(pr)) => run_number_for_pr(client, repo, pr)?,
(None, None) => bail!("ci-rerun: pass one of --run <n> or --pr <n>"),
let (workflow, branch) = match (args.pr, args.run, args.branch.as_deref()) {
(Some(pr), _, _) => (args.workflow.clone(), branch_for_pr(client, repo, pr)?),
(_, Some(run), _) => resolve_run(client, repo, run, &args.workflow)?,
(_, _, Some(branch)) => (args.workflow.clone(), branch.to_string()),
(None, None, None) => {
bail!("ci-rerun: pass one of --pr <n>, --run <n>, or --branch <name>")
}
};
let path = match args.job {
Some(job) => format!("/{repo}/actions/runs/{run}/jobs/{job}/rerun"),
None => format!("/{repo}/actions/runs/{run}/rerun"),
};
client.post_web_no_content(&path).with_context(|| {
format!(
"rerun run #{run}{} — the run may not exist, or the rerun route may \
differ on this Forgejo version",
args.job.map_or_else(String::new, |j| format!(" job {j}"))
)
})?;
let path = format!("/repos/{repo}/actions/workflows/{workflow}/dispatches");
client
.post_no_content(&path, &json!({ "ref": branch }))
.with_context(|| {
format!(
"dispatch workflow {workflow} on {branch} ({repo}) — the workflow \
file or the branch may not exist"
)
})?;
match args.job {
Some(job) => println!("re-running run #{run} job {job} on {repo}"),
None => println!("re-running all jobs of run #{run} on {repo}"),
}
println!("dispatched a fresh run of {workflow} on {branch} ({repo})");
Ok(())
}
/// Resolve a PR's latest CI run number from its head sha's combined status.
/// The Actions status `target_url` points at the run page
/// (`…/actions/runs/<n>/jobs/<i>`); we parse `<n>` out of it.
fn run_number_for_pr(client: &Client, repo: &str, pr: u64) -> Result<u64> {
/// Resolve a PR's head branch name (`head.ref`) — the branch a same-repo PR
/// pushes to, which is the ref we dispatch the workflow on.
fn branch_for_pr(client: &Client, repo: &str, pr: u64) -> Result<String> {
let pull = client.get_json(&format!("/repos/{repo}/pulls/{pr}"))?;
let sha = pull
.get("head")
.and_then(|h| h.get("sha"))
pull.get("head")
.and_then(|h| h.get("ref"))
.and_then(Value::as_str)
.with_context(|| format!("ci-rerun: PR #{pr} has no head.sha"))?;
let combined = client.get_json(&format!("/repos/{repo}/commits/{sha}/status"))?;
let statuses = combined
.get("statuses")
.and_then(Value::as_array)
.map(Vec::as_slice)
.unwrap_or_default();
statuses
.iter()
.filter_map(|s| s.get("target_url").and_then(Value::as_str))
.find_map(run_number_from_url)
.with_context(|| {
format!("ci-rerun: no Actions run found in PR #{pr}'s CI status (head {sha})")
})
.map(str::to_string)
.with_context(|| format!("ci-rerun: PR #{pr} has no head.ref"))
}
/// Pull the run number out of an Actions run-page URL, i.e. the `<n>` in
/// `…/actions/runs/<n>[/…]`. Returns `None` if the URL isn't a run URL.
fn run_number_from_url(url: &str) -> Option<u64> {
url.split_once("/actions/runs/")
.map(|(_, rest)| rest)
.map(|rest| rest.split(['/', '?', '#']).next().unwrap_or(rest))
.and_then(|n| n.parse::<u64>().ok())
/// Page the Actions runs list (newest-first) to find the run whose run-page
/// `html_url` ends in `/runs/<run-number>`, returning the `(workflow, branch)`
/// to dispatch a fresh run of it. `fallback_workflow` is used when the run
/// carries no workflow `path`.
fn resolve_run(
client: &Client,
repo: &str,
run_number: u64,
fallback_workflow: &str,
) -> Result<(String, String)> {
const PER_PAGE: u32 = 50;
const MAX_PAGES: u32 = 40;
for page in 1..=MAX_PAGES {
let path = format!("/repos/{repo}/actions/runs?limit={PER_PAGE}&page={page}");
let body = client.get_json(&path)?;
let runs = body
.get("workflow_runs")
.and_then(Value::as_array)
.cloned()
.unwrap_or_default();
if runs.is_empty() {
break;
}
for run in &runs {
if run_number_of(run) == Some(run_number) {
return run_dispatch_target(run, fallback_workflow)
.with_context(|| format!("ci-rerun: run #{run_number} has no head_branch"));
}
}
}
bail!("ci-rerun: run #{run_number} not found in {repo} (no matching workflow run)");
}
/// The per-repo run NUMBER from a run object's `html_url` (`…/runs/<n>` tail),
/// matching the `runs/<n>` the UI shows and `pr-status` surfaces.
fn run_number_of(run: &Value) -> Option<u64> {
run.get("html_url")
.and_then(Value::as_str)
.and_then(|u| u.rsplit('/').next())
.and_then(|s| s.parse::<u64>().ok())
}
/// Pull the `(workflow-file, branch)` dispatch target out of a run object:
/// `head_branch` is the branch, and the workflow file is the basename of the
/// run's `path` (e.g. `.forgejo/workflows/ci.yml` → `ci.yml`), falling back to
/// `fallback_workflow` when the run carries no usable `path`. `None` only when
/// the run has no `head_branch`.
fn run_dispatch_target(run: &Value, fallback_workflow: &str) -> Option<(String, String)> {
let branch = run.get("head_branch").and_then(Value::as_str)?;
let workflow = run
.get("path")
.and_then(Value::as_str)
.and_then(|p| p.rsplit('/').next())
.filter(|s| !s.is_empty())
.unwrap_or(fallback_workflow);
Some((workflow.to_string(), branch.to_string()))
}
#[cfg(test)]
mod tests {
use super::run_number_from_url;
use super::{run_dispatch_target, run_number_of};
use serde_json::json;
#[test]
fn parses_run_number_from_actions_url() {
fn parses_run_number_from_html_url() {
let run = json!({ "html_url": "http://forge/h/h/actions/runs/750" });
assert_eq!(run_number_of(&run), Some(750));
let run = json!({ "html_url": "https://forge/o/r/actions/runs/42" });
assert_eq!(run_number_of(&run), Some(42));
assert_eq!(
run_number_from_url("http://forge/h/h/actions/runs/750/jobs/0"),
Some(750)
run_number_of(&json!({ "html_url": "http://forge/o/r/x" })),
None
);
assert_eq!(run_number_of(&json!({})), None);
}
#[test]
fn extracts_workflow_and_branch() {
let run = json!({
"head_branch": "atlas/foo",
"path": ".forgejo/workflows/ci.yml",
});
assert_eq!(
run_number_from_url("https://forge/o/r/actions/runs/42"),
Some(42)
run_dispatch_target(&run, "fallback.yml"),
Some(("ci.yml".to_string(), "atlas/foo".to_string()))
);
assert_eq!(run_number_from_url("http://forge/o/r/commit/abc"), None);
assert_eq!(run_number_from_url("/actions/runs/notanumber/x"), None);
}
#[test]
fn falls_back_to_default_workflow_without_path() {
let run = json!({ "head_branch": "b" });
assert_eq!(
run_dispatch_target(&run, "fallback.yml"),
Some(("fallback.yml".to_string(), "b".to_string()))
);
}
#[test]
fn no_branch_means_no_target() {
assert_eq!(run_dispatch_target(&json!({}), "ci.yml"), None);
}
}