mirror of
https://github.com/element-hq/synapse
synced 2024-08-19 23:10:20 +00:00
Bumps [peaceiris/actions-mdbook](https://github.com/peaceiris/actions-mdbook) from 1.2.0 to 2.0.0. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/peaceiris/actions-mdbook/releases">peaceiris/actions-mdbook's releases</a>.</em></p> <blockquote> <h2>actions-mdbook v2.0.0</h2> <p>See <a href="https://github.com/peaceiris/actions-mdbook/blob/v2.0.0/CHANGELOG.md">CHANGELOG.md</a> for more details.</p> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/peaceiris/actions-mdbook/blob/main/CHANGELOG.md">peaceiris/actions-mdbook's changelog</a>.</em></p> <blockquote> <h1>Changelog</h1> <p>All notable changes to this project will be documented in this file. See <a href="https://github.com/conventional-changelog/standard-version">standard-version</a> for commit guidelines.</p> <h1><a href="https://github.com/peaceiris/actions-mdbook/compare/v1.2.0...v2.0.0">2.0.0</a> (2024-04-08)</h1> <h3>build</h3> <ul> <li>bump node to 20.12.1 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/504">#504</a>) (<a href="cb4d902e11
">cb4d902</a>), closes <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/504">#504</a></li> </ul> <h3>chore</h3> <ul> <li>revert build (<a href="c95f05c7f6
">c95f05c</a>)</li> </ul> <h3>ci</h3> <ul> <li>bump actions/checkout from 3 to 4 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/487">#487</a>) (<a href="c0c1ffeeae
">c0c1ffe</a>), closes <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/487">#487</a></li> <li>bump actions/dependency-review-action from 2.5.0 to 2.5.1 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/470">#470</a>) (<a href="e8a2552a1a
">e8a2552</a>), closes <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/470">#470</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/290">#290</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/300">#300</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/299">#299</a></li> <li>bump actions/dependency-review-action from 2.5.1 to 3.0.0 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/472">#472</a>) (<a href="9a6ded1ce6
">9a6ded1</a>), closes <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/472">#472</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/327">#327</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/324">#324</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/325">#325</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/326">#326</a></li> <li>bump actions/dependency-review-action from 3.0.0 to 3.0.1 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/473">#473</a>) (<a href="939fe7600f
">939fe76</a>), closes <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/473">#473</a></li> <li>bump actions/dependency-review-action from 3.0.1 to 3.0.2 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/474">#474</a>) (<a href="404c95aeed
">404c95a</a>), closes <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/474">#474</a></li> <li>bump actions/dependency-review-action from 3.0.2 to 3.0.3 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/476">#476</a>) (<a href="665e827a09
">665e827</a>), closes <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/476">#476</a></li> <li>bump actions/dependency-review-action from 3.0.3 to 3.0.4 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/479">#479</a>)Co-authored-by: dependabot[bot] <!-- raw HTML omitted --> (<a href="9d85c8a721
">9d85c8a</a>), closes <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/479">#479</a></li> <li>bump actions/dependency-review-action from 3.0.4 to 3.0.6 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/480">#480</a>) (<a href="a1c0a098b8
">a1c0a09</a>), closes <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/480">#480</a></li> <li>bump actions/dependency-review-action from 3.0.6 to 3.0.7 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/483">#483</a>) (<a href="2987c698ee
">2987c69</a>), closes <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/483">#483</a></li> <li>bump actions/dependency-review-action from 3.0.7 to 3.0.8 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/485">#485</a>) (<a href="162a198ca6
">162a198</a>), closes <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/485">#485</a></li> <li>bump actions/dependency-review-action from 3.0.8 to 3.1.0 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/488">#488</a>) (<a href="60cc2ffbc1
">60cc2ff</a>), closes <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/488">#488</a></li> <li>bump actions/setup-node from 3.5.1 to 3.6.0 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/475">#475</a>) (<a href="10da3f5364
">10da3f5</a>), closes <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/475">#475</a></li> <li>bump actions/setup-node from 3.6.0 to 3.7.0 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/481">#481</a>) (<a href="334df4e551
">334df4e</a>), closes <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/481">#481</a></li> <li>bump actions/setup-node from 3.7.0 to 3.8.0 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/484">#484</a>) (<a href="fe519205c0
">fe51920</a>), closes <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/484">#484</a></li> <li>bump actions/setup-node from 3.8.0 to 3.8.1 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/486">#486</a>) (<a href="c6c9e0f193
">c6c9e0f</a>), closes <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/486">#486</a></li> <li>bump codecov/codecov-action from 3 to 4 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/490">#490</a>) (<a href="7b0c98f8f3
">7b0c98f</a>), closes <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/490">#490</a></li> <li>bump github/codeql-action from 1 to 2 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/440">#440</a>) (<a href="7ce6923a7b
">7ce6923</a>), closes <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/440">#440</a></li> <li>bump peaceiris/actions-mdbook from 1.1.14 to 1.2.0 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/469">#469</a>) (<a href="59732c82f2
">59732c8</a>), closes <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/469">#469</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/397">#397</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/397">#397</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/385">#385</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/385">#385</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/407">#407</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/407">#407</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/409">#409</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/409">#409</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/424">#424</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/424">#424</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/463">#463</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/463">#463</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/393">#393</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/393">#393</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/395">#395</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/395">#395</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/399">#399</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/399">#399</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/400">#400</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/400">#400</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/405">#405</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/405">#405</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/411">#411</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/411">#411</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/412">#412</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/412">#412</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/416">#416</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/416">#416</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/435">#435</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/435">#435</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/438">#438</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/438">#438</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/456">#456</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/456">#456</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/460">#460</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/460">#460</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/462">#462</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/462">#462</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/371">#371</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/371">#371</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/437">#437</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/437">#437</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/392">#392</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/392">#392</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/394">#394</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/394">#394</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/396">#396</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/396">#396</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/402">#402</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/402">#402</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/404">#404</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/404">#404</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/436">#436</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/436">#436</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/373">#373</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/373">#373</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/374">#374</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/374">#374</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/377">#377</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/377">#377</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/380">#380</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/380">#380</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/381">#381</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/381">#381</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/383">#383</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/383">#383</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/384">#384</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/384">#384</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/382">#382</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/382">#382</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/466">#466</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/463">#463</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/462">#462</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/460">#460</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/456">#456</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/438">#438</a> <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/437">#437</a></li> </ul> <h3>feat</h3> <ul> <li>bump to node20 runtime (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/500">#500</a>) (<a href="46c97c2f70
">46c97c2</a>), closes <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/500">#500</a></li> </ul> <h1><a href="https://github.com/peaceiris/actions-mdbook/compare/v1.1.14...v1.2.0">1.2.0</a> (2022-10-23)</h1> <h3>chore</h3> <ul> <li>Add postinstall for husky install (<a href="0622767fb2
">0622767</a>)</li> <li>Convert templates to YAML issue forms (<a href="12969d1763
">12969d1</a>)</li> <li>Fix prettier (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/397">#397</a>) (<a href="44ecb22db7
">44ecb22</a>), closes <a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/397">#397</a></li> </ul> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="ee69d230fe
"><code>ee69d23</code></a> chore(release): 2.0.0</li> <li><a href="2d79d45dae
"><code>2d79d45</code></a> chore(release): Add build assets</li> <li><a href="c95f05c7f6
"><code>c95f05c</code></a> chore: revert build</li> <li><a href="cb4d902e11
"><code>cb4d902</code></a> build: bump node to 20.12.1 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/504">#504</a>)</li> <li><a href="46c97c2f70
"><code>46c97c2</code></a> feat: bump to node20 runtime (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/500">#500</a>)</li> <li><a href="7b0c98f8f3
"><code>7b0c98f</code></a> ci: bump codecov/codecov-action from 3 to 4 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/490">#490</a>)</li> <li><a href="60cc2ffbc1
"><code>60cc2ff</code></a> ci: bump actions/dependency-review-action from 3.0.8 to 3.1.0 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/488">#488</a>)</li> <li><a href="c0c1ffeeae
"><code>c0c1ffe</code></a> ci: bump actions/checkout from 3 to 4 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/487">#487</a>)</li> <li><a href="c6c9e0f193
"><code>c6c9e0f</code></a> ci: bump actions/setup-node from 3.8.0 to 3.8.1 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/486">#486</a>)</li> <li><a href="162a198ca6
"><code>162a198</code></a> ci: bump actions/dependency-review-action from 3.0.7 to 3.0.8 (<a href="https://redirect.github.com/peaceiris/actions-mdbook/issues/485">#485</a>)</li> <li>Additional commits viewable in <a href="adeb05db28...ee69d230fe
">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=peaceiris/actions-mdbook&package-manager=github_actions&previous-version=1.2.0&new-version=2.0.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
71 lines
2.3 KiB
YAML
71 lines
2.3 KiB
YAML
name: Prepare documentation PR preview
|
|
|
|
on:
|
|
pull_request:
|
|
paths:
|
|
- docs/**
|
|
- book.toml
|
|
- .github/workflows/docs-pr.yaml
|
|
- scripts-dev/schema_versions.py
|
|
|
|
jobs:
|
|
pages:
|
|
name: GitHub Pages
|
|
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@ee69d230fe19748b7abf22df32acaa93833fad08 # v2.0.0
|
|
with:
|
|
mdbook-version: '0.4.17'
|
|
|
|
- name: Setup python
|
|
uses: actions/setup-python@v5
|
|
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
|
|
# as the default. Let's opt for the welcome page instead.
|
|
run: |
|
|
mdbook build
|
|
cp book/welcome_and_overview.html book/index.html
|
|
|
|
- name: Upload Artifact
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
name: book
|
|
path: book
|
|
# We'll only use this in a workflow_run, then we're done with it
|
|
retention-days: 1
|
|
|
|
link-check:
|
|
name: Check links in documentation
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- name: Setup mdbook
|
|
uses: peaceiris/actions-mdbook@ee69d230fe19748b7abf22df32acaa93833fad08 # v2.0.0
|
|
with:
|
|
mdbook-version: '0.4.17'
|
|
|
|
- name: Setup htmltest
|
|
run: |
|
|
wget https://github.com/wjdp/htmltest/releases/download/v0.17.0/htmltest_0.17.0_linux_amd64.tar.gz
|
|
echo '775c597ee74899d6002cd2d93076f897f4ba68686bceabe2e5d72e84c57bc0fb htmltest_0.17.0_linux_amd64.tar.gz' | sha256sum -c
|
|
tar zxf htmltest_0.17.0_linux_amd64.tar.gz
|
|
|
|
- name: Test links with htmltest
|
|
# Build the book with `./` as the site URL (to make checks on 404.html possible)
|
|
# Then run htmltest (without checking external links since that involves the network and is slow).
|
|
run: |
|
|
MDBOOK_OUTPUT__HTML__SITE_URL="./" mdbook build
|
|
./htmltest book --skip-external
|