Skip to content

Commit 34e5bcf

Browse files
authored
Add an explanation of the autoupdate-branch workflow (#17798)
1 parent 3b56610 commit 34e5bcf

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

.github/workflows/autoupdate-branch.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,23 @@
11
name: autoupdate branch
2+
3+
#
4+
# This workflow checks all open PRs targeting `main` as their base branch and
5+
# will attempt to update them if they have the `autoupdate` label applied.
6+
# It is triggered when a `push` event occurs ON the `main` branch (e.g. a PR
7+
# was merged or a force-push was done).
8+
#
9+
# It should work on all PRs created from source branches within the repo itself
10+
# but is unlikely to work for PRs created from forked repos.
11+
#
12+
# It is still worthwhile to leave it enabled for the `docs` open source repo as
13+
# it should at least be running on `repo-sync` branch PRs.
14+
#
15+
216
on:
317
push:
418
branches:
519
- main
20+
621
jobs:
722
autoupdate:
823
if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'

0 commit comments

Comments
 (0)