Failure notification on the daily sync and add persist-credentials: false and a permissions. by whisper67265 · Pull Request #74 · cppalliance/boost-docs-translation

whisper67265 · 2026-07-31T07:09:38Z

Close #66, close #67.

Summary by CodeRabbit

New Features
- Added Slack notifications for translation workflow failures and stale synchronization heartbeat alerts.
- Notifications include workflow links, affected languages, and failed-job details.
Documentation
- Documented required Slack webhook configuration and secret usage in setup guides and the changelog.
Security
- Limited workflow repository permissions and prevented automatic reuse of checkout credentials.
Tests
- Added coverage for notification formatting, delivery, failure handling, webhook validation, and heartbeat alerts.

…ules.yml

whisper67265 · 2026-07-31T07:12:43Z

@coderabbitai, review

whisper67265 · 2026-07-31T07:15:51Z

@coderabbitai, fullreview

coderabbitai · 2026-07-31T07:20:44Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 19d9d04b-47b2-482d-8b65-034341353a74

📥 Commits

Reviewing files that changed from the base of the PR and between 3a52790 and e0d87bf.

📒 Files selected for processing (9)

.github/workflows/assets/notify.sh
.github/workflows/heartbeat.yml
CHANGELOG.md
README.md
docs/GETTING-STARTED.md
tests/helpers/common.bash
tests/helpers/http_mock.bash
tests/helpers/mock_gh.bash
tests/test_notify.bats

🚧 Files skipped from review as they are similar to previous changes (6)

.github/workflows/heartbeat.yml
.github/workflows/assets/notify.sh
CHANGELOG.md
tests/helpers/common.bash
README.md
docs/GETTING-STARTED.md

📝 Walkthrough

Walkthrough

The workflows now send Slack alerts for translation sync failures and stale heartbeat checks. A shared notification script builds workflow URLs, failed-job summaries, and Slack payloads. Tests mock Slack and GitHub CLI requests. Checkout permissions are restricted and persisted credentials are disabled.

Changes

Slack alerting

Layer / File(s)	Summary
Notification construction and delivery `.github/workflows/assets/notify.sh`	Adds helpers for workflow URLs, failed-job summaries, Slack payloads, webhook delivery, sync failure alerts, and stale heartbeat alerts.
Workflow integration and access configuration `.github/workflows/sync-translation.yml`, `.github/workflows/heartbeat.yml`, `.github/workflows/add-submodules.yml`, `README.md`, `docs/GETTING-STARTED.md`, `CHANGELOG.md`	Adds notification workflow steps, documents `SLACK_WEBHOOK_URL`, updates checkout behavior, and records the alert changes.
Notification validation and lint coverage `tests/test_notify.bats`, `tests/helpers/common.bash`, `tests/helpers/http_mock.bash`, `tests/helpers/mock_gh.bash`, `scripts/lint.sh`	Adds notification setup, Slack and GitHub CLI mocks, Bats tests, and ShellCheck coverage.

Estimated code review effort: 3 (Moderate) | ~22 minutes

Sequence Diagram(s)

sequenceDiagram
  participant SyncWorkflow
  participant notify-failure
  participant notify.sh
  participant GitHubCLI
  participant Slack
  SyncWorkflow->>notify-failure: detect discover or sync-local failure
  notify-failure->>notify.sh: invoke failure notification
  notify.sh->>GitHubCLI: retrieve failed workflow jobs
  notify.sh->>Slack: send formatted webhook payload

Possibly related issues

cppalliance/boost-docs-translation#67 — The add-submodules.yml changes implement the issue’s permission and credential persistence updates.

Possibly related PRs

cppalliance/boost-docs-translation#72 — This PR extends the heartbeat workflow with stale-heartbeat Slack notifications.

Suggested reviewers: wpak-ai, henry0816191

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 25.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title identifies the main failure-notification change and related workflow security settings, although its wording is awkward.
Linked Issues check	✅ Passed	The changes implement the Slack alerts, stale-heartbeat handling, secret documentation, shared tooling, and tests required by issue [`#66`].
Out of Scope Changes check	✅ Passed	The workflow, documentation, notification script, and test changes are directly related to the linked issue objectives.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/workflows/assets/notify.sh:
- Around line 52-60: Update send_slack_notification so its curl request includes
short connection and total request timeouts via --connect-timeout and
--max-time, while preserving the existing POST payload, headers, webhook URL,
and failure behavior.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 499b07c4-6535-4869-91c2-3a5bad136b50

📥 Commits

Reviewing files that changed from the base of the PR and between 01fa10d and 2de973d.

📒 Files selected for processing (11)

.github/workflows/add-submodules.yml
.github/workflows/assets/notify.sh
.github/workflows/heartbeat.yml
.github/workflows/sync-translation.yml
CHANGELOG.md
README.md
docs/GETTING-STARTED.md
scripts/lint.sh
tests/helpers/common.bash
tests/helpers/http_mock.bash
tests/test_notify.bats

coderabbitai · 2026-07-31T07:23:51Z

@whisper67265, I will review the changes.

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai · 2026-07-31T07:35:49Z

@whisper67265, I will perform a complete review of pull request #74.

✅ Action performed

Full review finished.

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/GETTING-STARTED.md`:
- Around line 58-64: Update the workflow-specific requirements section in
GETTING-STARTED.md to state that sync-translation requires SYNC_TOKEN and
notify-failure requires SLACK_WEBHOOK_URL. Keep the existing descriptions and
formatting consistent with the surrounding documentation.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4bb3b067-ff42-4030-9370-c22055b3f541

📥 Commits

Reviewing files that changed from the base of the PR and between 01fa10d and 3aa8a53.

📒 Files selected for processing (11)

.github/workflows/add-submodules.yml
.github/workflows/assets/notify.sh
.github/workflows/heartbeat.yml
.github/workflows/sync-translation.yml
CHANGELOG.md
README.md
docs/GETTING-STARTED.md
scripts/lint.sh
tests/helpers/common.bash
tests/helpers/http_mock.bash
tests/test_notify.bats

whisper67265 added 2 commits July 31, 2026 01:02

failure notification on the daily sync

562ac42

add persist-credentials: false and a permissions: block to add-submod…

2de973d

…ules.yml

fix the coderabbitai review comments

3aa8a53

coderabbitai Bot reviewed Jul 31, 2026

View reviewed changes

Comment thread .github/workflows/assets/notify.sh

whisper67265 requested a review from henry0816191 July 31, 2026 07:34

coderabbitai Bot reviewed Jul 31, 2026

View reviewed changes

Comment thread docs/GETTING-STARTED.md Outdated

whisper67265 added 2 commits July 31, 2026 02:05

fix the coderabbitai review comments

09f8237

fix the first reviewer comments

3a52790

henry0816191 approved these changes Jul 31, 2026

View reviewed changes

whisper67265 requested a review from wpak-ai July 31, 2026 13:40

whisper67265 added 2 commits July 31, 2026 10:14

fix the second reviewer comments

5ef7597

Merge branch 'master' into feature/sync-failure-slack-alerts

e0d87bf

wpak-ai approved these changes Jul 31, 2026

View reviewed changes

wpak-ai merged commit 6a5617f into cppalliance:master Jul 31, 2026
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Failure notification on the daily sync and add persist-credentials: false and a permissions. - #74

Failure notification on the daily sync and add persist-credentials: false and a permissions.#74
wpak-ai merged 7 commits into
cppalliance:masterfrom
whisper67265:feature/sync-failure-slack-alerts

whisper67265 commented Jul 31, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

whisper67265 commented Jul 31, 2026

Uh oh!

whisper67265 commented Jul 31, 2026

Uh oh!

coderabbitai Bot commented Jul 31, 2026 •

edited

Loading

Reviews paused

Walkthrough

Changes

Sequence Diagram(s)

❌ Failed checks (1 warning)

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

coderabbitai Bot commented Jul 31, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Jul 31, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

whisper67265 commented Jul 31, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

whisper67265 commented Jul 31, 2026

Uh oh!

whisper67265 commented Jul 31, 2026

Uh oh!

coderabbitai Bot commented Jul 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Walkthrough

Changes

Sequence Diagram(s)

❌ Failed checks (1 warning)

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai Bot commented Jul 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Jul 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

whisper67265 commented Jul 31, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jul 31, 2026 •

edited

Loading

coderabbitai Bot commented Jul 31, 2026 •

edited

Loading

coderabbitai Bot commented Jul 31, 2026 •

edited

Loading