Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make sync_docs failures noisier by always posting a PR #288

Merged
merged 6 commits into from
Nov 4, 2024

Conversation

huonw
Copy link
Contributor

@huonw huonw commented Nov 4, 2024

This makes us more likely to notice problems in the automatic doc syncing like #284 earlier, by surfacing the failures as PRs, not just hidden in the actions UI.

The doc syncing usually happens automagically as part of the release process, in the background. If it fails, this is only visible in two ways:

Both of these are easy to miss (very easy to miss that something that should happen didn't happen, and the actions page is only rarely visited!). There's no progress updates/reminder about the doc sync, nor is there a notification on failure.

In practice, we missed failures on the 2.24.x branch for a few releases (in #284).

This PR adds a "notification" about the failure, by posting the sync PR unconditionally. The release manager thus gets a notification (about their review request) and it's visible/easier for others to notice it too, in the list of PRs. When there's a failure, this PR includes some extra notes to highlight it.

Examples triggered from this branch:

Copy link
Member

@thejcannon thejcannon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the idea!

.github/workflows/sync_docs.yml Outdated Show resolved Hide resolved
@huonw huonw enabled auto-merge (squash) November 4, 2024 22:02
@huonw huonw merged commit 7457490 into main Nov 4, 2024
1 check passed
@huonw huonw deleted the huonw/noisy-sync-failures branch November 4, 2024 22:17
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.

2 participants