Repository navigation
[Docs] Skip release notes checks on draft PRs - #300949
Merged
Merged
Conversation
Draft PRs get a failed release notes check and a "Changelog labels needed" comment before the author is ready. skip-drafts skips both on drafts. The ready_for_review event runs the checks when the PR is ready, and converted_to_draft clears a failed check when a PR goes back to draft. Needs elastic/docs-actions#442 in docs-actions v1. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0198Z15QXfthJ2QgGztrDHtu
theletterf
added
Team:Docs
release_note:skip
Claude
This was referenced Oct 27, 2026
theletterf
marked this pull request as ready for review
October 27, 2026 18:05
Contributor
|
Pinging @elastic/experience-docs (Team:Docs) |
Contributor
💚 Build Succeeded
|
tylersmalley
approved these changes
Oct 27, 2026
A draft PR skips the release notes check, so its run ends as skipped and leaves no decision to post. The comment job then started only to find nothing. This condition stops it from starting. Suggested in #300954. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This file contains hidden or 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
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.
Summary
Draft PRs no longer get the release notes check or the "Changelog labels needed" comment. The check runs when the PR is marked ready for review.
Today
release-notes / validateruns on every PR, drafts included. A draft that has no team label yet gets a failed check and a comment. Adding the label early pings the team before the work is ready for review. An example is #300907.This PR changes
.github/workflows/release-notes.ymland.github/workflows/release-notes-comments.yml.In
release-notes.yml:skip-drafts: trueskips the check and the comment while the PR is a draft. The skipped check does not block anything, because GitHub cannot merge a draft.ready_for_reviewruns the check as soon as the PR leaves draft. Without this event, a PR that leaves draft is not checked until the next push or label change.converted_to_draftreplaces a failed check with a skipped one when a PR goes back to draft.In
release-notes-comments.yml, the comment job no longer starts when therelease-notesrun was skipped, which is what a draft PR produces. It used to start, find no decision, post nothing, and end green. Now it does not use a runner. This does not change what appears on a PR. It comes from #300954.Depends on: elastic/docs-actions#442, released in
docs-actions1.69.0.v1declares theskip-draftsinput.The change was tested end to end in https://github.com/elastic/docs-playground-release-notes-tagged/pull/75: ready → failed check and comment; back to draft → skipped; push while draft → skipped; ready again → failed check and updated comment.
Checklist
release_note:*label is applied per the guidelines —release_note:skip.backport:*labels —backport:skip.Identify risks
ready_for_reviewrun, it could merge with a skipped check; theready_for_reviewtrigger in this PR prevents that.Generated by Claude Code