Skip to content

Commit 6a71f58

Browse files
committed
ci: wiki sync
1 parent aa17bfb commit 6a71f58

1 file changed

Lines changed: 47 additions & 0 deletions

File tree

.github/workflows/wiki-sync.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Docs <-> Wiki
2+
3+
on:
4+
push:
5+
branches:
6+
# Name a branch "docs-preview" if you want commits to the branch to apply to the wiki
7+
# immediately. Helpful if you want to make multiple updates, preview them, merge commits, etc.
8+
# before finally merging to master.
9+
- docs-preview
10+
11+
# With the above exception, doc updates will only by synced to the wiki when merged to the
12+
# default branch.
13+
#
14+
# TODO: confirm or change default branch name for your repo
15+
- main
16+
paths:
17+
# TODO: this should match where your wiki docs are synced to. E.g. "docs/**"
18+
- "wiki/**"
19+
20+
# gollum is the wiki add/update event and this only triggers for the default branch. I.e. if
21+
# an update is made to the wiki, only the master branch will be updated.
22+
gollum:
23+
24+
# Limit this workflow to a single run at a time to avoid race conditions
25+
concurrency:
26+
group: ${{ github.workflow }}-${{ github.ref }}
27+
cancel-in-progress: true
28+
29+
permissions:
30+
contents: write
31+
jobs:
32+
sync-docs:
33+
# Avoid cyclical sync when the wiki is updated. GitHub has built-in protection for push event.
34+
if: github.event_name != 'gollum' || !contains(github.event.pages[0].summary, 'wiki sync bot:')
35+
runs-on: ubuntu-24.04
36+
steps:
37+
- name: Checkout Repo
38+
uses: actions/checkout@v4
39+
40+
- name: GitHub Wiki Sync
41+
uses: level12/gh-action-wiki-sync@main
42+
with:
43+
# TODO: change this if your docs are in a directory other than "wiki"
44+
# docs_path: wiki
45+
46+
# TODO: change this to a personal access token secret for better security
47+
github_token: ${{ github.token }}

0 commit comments

Comments
 (0)