Skip to content

Replace "draft trick" documentation with auto-merge flow #501

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.

Sign up for GitHub

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

Open
ppkarwasz wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −40
Open

Replace "draft trick" documentation with auto-merge flow #501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions .github/workflows/build.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,6 @@ on:
- "**.md"
- "**.txt"
pull_request:
types:
# Standard types
- opened
- synchronize
- reopened
# Used in Dependabot PRs to retrigger required workflows
- ready_for_review

# If the branch is `main`, run once per commit.
# If the branch is `release/*`, allow only one concurrent run.
Expand Down
7 changes: 0 additions & 7 deletions .github/workflows/codeql-analysis.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,6 @@ on:
pull_request:
branches:
- "main"
types:
# Standard types
- opened
- synchronize
- reopened
# Used in Dependabot PRs to retrigger required workflows
- ready_for_review
schedule:
- cron: '32 12 * * 5'

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/process-dependabot.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ jobs:
}}
uses: apache/logging-parent/.github/workflows/process-dependabot-reusable.yaml@gha/v0
permissions:
# The default GITHUB_TOKEN will be used to enable the "auto-merge" on the PR
# This requires the following two permissions:
# Append the changelog commit
contents: write
# Enable auto-merge on the PR
pull-requests: write
with:
# The path to the changelog directory for the current development branch.
Expand Down
2 changes: 1 addition & 1 deletion src/site/antora/modules/ROOT/examples/process-dependabot.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ jobs:
permissions:
# Append the changelog commit
contents: write
# Convert the PR into draft
# Enable auto-merge on the PR
pull-requests: write
with:
# The path to the changelog directory for the current development branch.
Expand Down
31 changes: 8 additions & 23 deletions src/site/antora/modules/ROOT/pages/workflows.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,39 +127,24 @@ include::example$analyze-dependabot.yaml[tag=analyze-dependabot,indent=0]
Helps to process Dependabot pull requests by:

* Generating changelog entries for the updated dependencies and committing them to the PR branch.
* Switching the pull request into “draft mode”.
* Enabling the “auto-merge” option on the pull request.

The workflow only needs the default `GITHUB_TOKEN` with `contents: write` and `pull-requests: write` permissions.

This workflow is designed to be triggered by the `workflow_run` event, as soon as the <<analyze-dependabot>> workflow completes.

[NOTE]
====
Pushes made with `GITHUB_TOKEN` do not retrigger workflows (GitHub anti-recursion rule), so the changelog commit cannot re-run the required checks on its own.
This reusable workflow therefore parks the PR in “draft mode” and stops there.
Pushes made with `GITHUB_TOKEN` do not automatically retrigger workflows (GitHub anti-recursion rule), so the changelog commit cannot re-run the required checks on its own.
However,
https://github.blog/changelog/2026-06-11-bot-created-pull-requests-can-run-workflows-if-approved/[since June 2026],
the workflow runs are created in an approval-required state instead of being dropped, and a maintainer can start them manually.

The expected flow for each Dependabot PR is:

. The reusable workflow appends the changelog commit and converts the PR into draft.
. A maintainer reviews the change, clicks *Ready for review*, and enables *Auto-merge*.
. The required-check workflows re-run against the new HEAD; once they pass, *Auto-merge* completes the merge without further manual action.

For step 3 to work, every workflow providing a required check must subscribe to `ready_for_review`:

[source,yaml]
----
on:
pull_request:
types:
# Standard types
- opened
- synchronize
- reopened
# Used in Dependabot PRs to retrigger required workflows
- ready_for_review
----

This reusable workflow does **not** enable “Auto-merge”; a maintainer must do that by hand.
. The reusable workflow appends the changelog commit to the PR branch and enables “auto-merge”.
. A maintainer reviews the change, approves the PR, and clicks *Approve workflows to run*.
. The required-check workflows run against the new HEAD; once they pass, *Auto-merge* completes the merge without further manual action.
====

.Snippet from an {examples-base-link}/process-dependabot.yaml[example `process-dependabot.yaml`] using this workflow
Expand Down
Loading