devstack-core/.github/workflows/wiki-sync.yml at main · NormB/devstack-core · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
name: Wiki Sync

# The wiki/ directory mirrors a fixed set of documentation files. The set
# lives in scripts/wiki-mirror.sh, which copies the files locally
# (`make wiki-mirror`) and checks them here. This job only checks: the
# repository ruleset requires signed commits on every branch, so a workflow
# cannot commit the copies itself, and a copy that is out of date is a
# change the author forgot to include, which is theirs to add.
on:
  push:
    branches: [main]
    paths:
      - 'docs/**'
      - 'README.md'
      - '.github/CHANGELOG.md'
      - 'wiki/**'
      - 'scripts/wiki-mirror.sh'
      - '.github/workflows/wiki-sync.yml'
  pull_request:
    branches: [main]
    paths:
      - 'docs/**'
      - 'README.md'
      - '.github/CHANGELOG.md'
      - 'wiki/**'
      - 'scripts/wiki-mirror.sh'
      - '.github/workflows/wiki-sync.yml'
  workflow_dispatch:

# One run per workflow per ref. Merging a queue of dependency PRs fires a
# run per commit on main, and every one but the newest is already stale by
# the time a runner picks it up.
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: false

permissions:
  contents: read

jobs:
  sync-wiki:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v7

      - name: Check the wiki copies are current
        run: ./scripts/wiki-mirror.sh --check