Skip to content

docs(recipes): restore duration_seconds + version pin sweep#17

Merged
zuchka merged 1 commit into
mainfrom
recipe-template-sweep
May 9, 2026
Merged

docs(recipes): restore duration_seconds + version pin sweep#17
zuchka merged 1 commit into
mainfrom
recipe-template-sweep

Conversation

@zuchka
Copy link
Copy Markdown
Collaborator

@zuchka zuchka commented May 9, 2026

Summary

Item 3 of 4 in the inward-polish roadmap. Pure docs sweep across docs/recipes/ (no code).

  • Restores {{ .duration_seconds }} to every run.exit message template (8 platform recipes + _template.md). Engine support landed in v0.10.0 (commit 5fda9c1) but no recipe had been re-adopted since the feature was stripped from mlflow in fcdc11e.
  • Normalizes DING binary pin to >= v0.10.0 across all 9 files (was a range of v0.3.0–v0.8.0).
  • Bumps container image tag (ghcr.io/ding-labs/ding:v0.7.0:v0.10.0) in argo + k8s recipes (3 occurrences each).
  • Adjacent consistency: drain_timeout deep-link in 5 recipes (gitlab-ci, jenkins, buildkite, mlflow, ray), "full notifier reference" phrasing in modal + ray Configuration sections, internal/ingester/json.go leak removed from modal.
  • mlflow/modal/ray's "What you get" rendered exit-alert excerpts updated to match the YAML (illustrative durations: 42s / 287s / 1843s).

mode: end-of-run sweep already shipped in 9cca220; no changes there.

The 3 "for the full reference" instances in gitlab-ci, buildkite, kubernetes-jobs that link to a specific notifier type are deliberately left as-is — different sentence pattern.

Test plan

  • grep -L ">= v0.10.0" docs/recipes/*.md — empty (all pinned)
  • grep -L "duration_seconds" docs/recipes/*.md — empty (all reference it)
  • Anchor sweep across recipes — 11 internal .md#anchor refs all resolve
  • ding validate --config on extracted buildkite + mlflow YAML — both exit 0
  • ding test-rule end-to-end render: synthetic run.exit event with duration_seconds=42.5 renders (exit 1 after 42.5s) (not <no value>)
  • Visual diff review — 33 ins / 33 del, no whitespace drift, no unintended edits

Out of scope (deliberately)

  • mode: end-of-run sweep (already shipped in 9cca220)
  • Recipe section restructuring
  • index.md status changes

🤖 Generated with Claude Code

Restores {{ .duration_seconds }} to every run.exit message template
across all 8 platform recipes plus _template.md. The reference was
stripped from mlflow in fcdc11e because Float-typed event fields were
unreachable from message templates; commit 5fda9c1 fixed the engine
(shipped v0.10.0) but no recipe ever re-adopted the feature.

Bumps DING binary pin to >= v0.10.0 across all 9 files (was a range
of v0.3.0–v0.8.0 reflecting authoring time, not feature requirement)
and the container image tag in argo + k8s recipes to match.

Adjacent consistency fixes:
- drain_timeout link in 5 recipes (gitlab-ci, jenkins, buildkite,
  mlflow, ray) deep-links to the configuration.md anchor.
- modal + ray phrase "full notifier reference" matching the other 6
  recipes' Configuration-section convention. Three other "full
  reference" instances in native-surfacing sections (gitlab-ci,
  buildkite, k8s) are left as-is — they reference a specific notifier
  type, a different sentence pattern.
- modal.md drops a leak of the internal/ingester/json.go path.

Three ML recipes (mlflow, modal, ray) also update their rendered
exit-alert excerpts in the "What you get" section to match the YAML
message — illustrative durations: 42s / 287s / 1843s.

mode: end-of-run sweep already shipped in 9cca220; no changes there.

Verified via:
- grep uniformity (every recipe pinned + carries duration_seconds)
- markdown anchor sweep (11 internal refs resolve)
- ding validate on extracted buildkite + mlflow YAML
- ding test-rule render check: synthetic run.exit event with
  duration_seconds=42.5 renders "after 42.5s" in the alert text

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@zuchka zuchka merged commit c99c57e into main May 9, 2026
1 check passed
@github-actions github-actions Bot locked and limited conversation to collaborators May 9, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant