[FAILURE] Update docs site for version 2.24.0.dev3 #290
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WorkerPants
added
the
automation:sync-docs
|
Just an example for #288 |
huonw
added a commit
that referenced
this pull request
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: - implicitly, in the lack of <https://github.com/pantsbuild/pantsbuild.org/labels/automation%3Async-docs>-labelled PR - by noticing the failure on the actions page: https://github.com/pantsbuild/pantsbuild.org/actions/workflows/sync_docs.yml 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: - successful run (unchanged): #291 - unsuccessful run (new): #290 --------- Co-authored-by: Josh Cannon <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Docs from https://github.com/pantsbuild/pants/releases/tag/release_2.24.0.dev3
The sync_docs job failed part way through and may need debugging: https://github.com/pantsbuild/pantsbuild.org/actions/runs/11658997999
Note: to retry the job, first close this PR and delete its branch.