Skip to content

[SDCI-2079] Document automatic job retries (Preview) - inline approach#36148

Closed
afontan wants to merge 3 commits intomasterfrom
alejandro.fontan/SDCI-2079-auto-retries-inline
Closed

[SDCI-2079] Document automatic job retries (Preview) - inline approach#36148
afontan wants to merge 3 commits intomasterfrom
alejandro.fontan/SDCI-2079-auto-retries-inline

Conversation

@afontan
Copy link
Copy Markdown
Contributor

@afontan afontan commented Apr 20, 2026

What does this PR do? What is the motivation?

Fixes SDCI-2079

Adds customer-facing documentation for the automatic job retries feature on GitHub Actions and GitLab. The feature is in Preview.

Approach B — Inline on each provider page. This is one of three variant PRs opened to compare documentation structures.

Changes:

  • github.md — new inline ## Automatic job retries section with GitHub-specific behavior, and a new row in the Compatibility table linking to the anchor.
  • gitlab.md — new inline ## Automatic job retries section with GitLab smart-retry behavior, and a new row in the Compatibility table linking to the anchor.
  • pipelines/_index.md — new row in the Supported features matrix (no cross-page link; section lives on each provider page).

Other approaches in review:

  • Approach A — dedicated page plus a row in each provider's compatibility table.
  • Approach C — dedicated page only, no per-provider references.

Merge instructions

Merge readiness:

  • Ready for merge

Additional notes

Tone is Preview / private beta; access is gated via Datadog account team. Internal implementation details are intentionally excluded.

Adds customer-facing documentation for the automatic job retries
feature on GitHub Actions and GitLab. The feature is documented
inline on each provider's setup page, with a row in the supported
features matrix on the pipelines index.
- Replace "hiccups" colloquialism with "failures".
- Split long em-dashed sentence in Overview into two sentences.
- Replace passive "the retry outcome is reflected" with active.
- Replace "configurable maximum" with "maximum number of attempts" since
  the limit is not customer-tunable today.
- Replace "when the failure is determined retriable" with "when the failure
  is identified as retriable".
- Replace quoted "rerun failed jobs" with plain prose (GitHub API call).
- Replace awkward "compute minutes consumed by your pipelines" with
  "GitHub Actions compute usage".
- Add missing "as" in "aren't classified retriable" (GitLab section).
- Replace em dash with period in access-gating sentence.
@afontan
Copy link
Copy Markdown
Contributor Author

afontan commented Apr 21, 2026

Editorial review (post-fix round)

The shared prose fixes look good. Remaining issues below; one must-fix is specific to this inline approach.

Higher-level

  • Requirements lists — inconsistent item structure + banner redundancy (both github.md and gitlab.md sections). Bullets 1-2 are fragments; bullet 3 mixes a fragment with two full sentences that duplicate the top banner.
  • GitLab Requirements bullet 2 combines two concerns in a single bullet (configuration requirement + version support). Split into two bullets or move the version info into a separate sentence under the list.
  • "Preview." cell prefix still worth aligning with team convention before merging.

Must fix

content/en/continuous_integration/pipelines/github.md — Requirements list consistency + banner redundancy

- CI Visibility enabled for your GitHub Actions integration (see [Configure the Datadog integration](#configure-the-datadog-integration)).
- [Datadog Source Code Integration][27] configured for the repositories where you want automatic retries.
- Automatic job retries enabled for your organization (see banner above for how to request access).

content/en/continuous_integration/pipelines/gitlab.md — Requirements list: split concerns + banner redundancy

- CI Visibility enabled for your GitLab integration (see [Configure the Datadog integration](#configure-the-datadog-integration)).
- [Datadog Source Code Integration][31] configured for the repositories where you want automatic retries.
- Smart retries work with GitLab.com (SaaS) and with self-hosted GitLab instances reachable by the Source Code Integration.
- Automatic job retries enabled for your organization (see banner above for how to request access).

Suggestions

github.md + gitlab.md — "Genuine code defects are left alone." is idiomatic. Prefer Genuine code defects are not retried.

gitlab.md — Step 3 of How it works reads oddly:

If the failure is classified as retriable, Datadog requests a retry through the GitLab API, per job, as soon as the job finishes failing.

Prefer:

If the failure is classified as retriable, Datadog requests a retry through the GitLab API as soon as the job fails. Retries are dispatched per job.

Or simply: ...as soon as the job fails.

Compatibility cell prefix — flag rather than fix. Ask docs team for convention. No row in either provider's compatibility table currently uses a status prefix like Preview.

Link verification

  • Compat rows use in-page anchors #automatic-job-retries — both generated from the new ## Automatic job retries headings. ✓
  • [27]: /integrations/guide/source-code-integration/ — ✓
  • [31]: /integrations/guide/source-code-integration/ — ✓

Verdict

Comment — two must-fix items (Requirements list structure on each provider page), plus polish suggestions. Previous round of fixes addressed the bigger issues well.

- Collapse Requirements bullet 3 in both sections; redirect readers to
  the banner instead of repeating access-request instructions.
- Replace "Genuine code defects are left alone" with "not retried" in
  both sections.
- GitLab section: split step 3 into two sentences ("as soon as the job
  fails"; retries are dispatched per job).
- GitLab section: split Requirements bullet 2 to separate the SCI
  configuration requirement from the GitLab instance support statement,
  and drop the redundant second "with".
@afontan
Copy link
Copy Markdown
Contributor Author

afontan commented Apr 21, 2026

Closing in favor of approach A (hybrid) — #36147. Thanks to everyone who weighed in.

@afontan afontan closed this Apr 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant