Repository navigation
ci: skip the release notes checks on draft pull requests - #1295
Open
theletterf wants to merge 1 commit into
Open
theletterf wants to merge 1 commit into
theletterf wants to merge 1 commit into
Conversation
A draft pull request gets a failed release notes check and a changelog comment before the author is ready. The skip-drafts input skips both on drafts. The ready_for_review event runs the checks when a draft is ready, and converted_to_draft clears a failed check when a pull request goes back to draft. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Member
Author
|
@SylvainJuge Ready to merge |
There was a problem hiding this comment.
🟢 Approval recommended
The supported input and both required transition triggers are configured, with no unresolved issues identified.
No open issues 🎉
What changed in this PR
Opts this repository into the shared release-notes workflow’s draft-skipping support introduced in elastic/docs-actions#442.
Changes:
- Enables
skip-draftsto avoid validation failures and new bot comments on draft pull requests. - Adds
ready_for_reviewandconverted_to_drafttriggers so validation follows draft-state changes. - Preserves existing event triggers and push behavior.
| File | Description |
|---|---|
.github/workflows/release-notes.yml |
Enables draft skipping and adds both draft-transition triggers. |
Review effort: Balanced
This branch has not been deployed
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.
Draft pull requests in this repository get a failed
release-notes / validatecheck and a "Changelog labels needed" comment before the author is ready for review. Authors then add labels early just to quiet the bot. The sharedrelease-notesworkflow now has an opt-inskip-draftsinput, released inelastic/docs-actionsv1 with elastic/docs-actions#442. This pull request turns it on here.In
.github/workflows/release-notes.yml:skip-drafts: trueskips the check and the comment while the pull request is a draft. GitHub cannot merge a draft, so the skipped check never lets an unchecked change through.ready_for_reviewruns the check as soon as a draft is marked ready. Without it, nothing checks the pull request until the next push or label change.converted_to_draftreplaces a failed check with a skipped one when a pull request goes back to draft.This pull request is a draft on purpose, so its own
release-notes / validatecheck should show as skipped. Mark it ready for review and the check runs. If you add a type label (changelog:skipfits a CI-only change), it passes.The same change is going into Kibana,
docs-builder, anddocs-content. Nothing else in the workflow changes, andrelease-notes-comments.ymlandrelease-notes-changelog-file.ymlstay as they are.🤖 Generated with Claude Code