diff options
| author | Patrick Cloke <clokep@users.noreply.github.com> | 2023-11-28 11:01:24 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-11-28 11:01:24 -0500 |
| commit | 77882b6a7d1ad1ab76b0ff878b3daed894bdb26e (patch) | |
| tree | 01c34760f3bb2aef2b8cd44a110d5e2f1e325705 /.github | |
| parent | Ignore `encryption_enabled_by_default_for_room_type` for notices room (#16677) (diff) | |
| download | synapse-77882b6a7d1ad1ab76b0ff878b3daed894bdb26e.tar.xz | |
Document which versions of Synapse have compatible schema versions. (#16661)
Diffstat (limited to '.github')
| -rw-r--r-- | .github/workflows/docs-pr.yaml | 11 | ||||
| -rw-r--r-- | .github/workflows/docs.yaml | 10 |
2 files changed, 21 insertions, 0 deletions
diff --git a/.github/workflows/docs-pr.yaml b/.github/workflows/docs-pr.yaml index 3704bd66e2..9cf3d340a4 100644 --- a/.github/workflows/docs-pr.yaml +++ b/.github/workflows/docs-pr.yaml @@ -6,6 +6,7 @@ on: - docs/** - book.toml - .github/workflows/docs-pr.yaml + - scripts-dev/schema_versions.py jobs: pages: @@ -13,12 +14,22 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 + with: + # Fetch all history so that the schema_versions script works. + fetch-depth: 0 - name: Setup mdbook uses: peaceiris/actions-mdbook@adeb05db28a0c0004681db83893d56c0388ea9ea # v1.2.0 with: mdbook-version: '0.4.17' + - name: Setup python + uses: actions/setup-python@v4 + with: + python-version: "3.x" + + - run: "pip install 'packaging>=20.0' 'GitPython>=3.1.20'" + - name: Build the documentation # mdbook will only create an index.html if we're including docs/README.md in SUMMARY.md. # However, we're using docs/README.md for other purposes and need to pick a new page diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index c7cb2d78e5..31b9dbe3fe 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -51,12 +51,22 @@ jobs: - pre steps: - uses: actions/checkout@v4 + with: + # Fetch all history so that the schema_versions script works. + fetch-depth: 0 - name: Setup mdbook uses: peaceiris/actions-mdbook@adeb05db28a0c0004681db83893d56c0388ea9ea # v1.2.0 with: mdbook-version: '0.4.17' + - name: Setup python + uses: actions/setup-python@v4 + with: + python-version: "3.x" + + - run: "pip install 'packaging>=20.0' 'GitPython>=3.1.20'" + - name: Build the documentation # mdbook will only create an index.html if we're including docs/README.md in SUMMARY.md. # However, we're using docs/README.md for other purposes and need to pick a new page |