2023-10-17 00:57:03 +02:00
|
|
|
name: Deploy documentation
|
|
|
|
|
|
|
|
|
|
on:
|
|
|
|
|
push:
|
|
|
|
|
branches: [develop]
|
|
|
|
|
workflow_dispatch: {}
|
|
|
|
|
|
2023-10-17 09:58:27 +02:00
|
|
|
permissions:
|
|
|
|
|
contents: read
|
|
|
|
|
pages: write
|
|
|
|
|
id-token: write
|
|
|
|
|
|
|
|
|
|
concurrency:
|
|
|
|
|
group: "pages"
|
|
|
|
|
cancel-in-progress: false
|
|
|
|
|
|
2023-10-17 00:57:03 +02:00
|
|
|
jobs:
|
2023-10-17 09:58:27 +02:00
|
|
|
build:
|
2023-10-17 00:57:03 +02:00
|
|
|
name: GitHub Pages
|
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
|
steps:
|
|
|
|
|
- name: Fetch element-desktop
|
|
|
|
|
uses: actions/checkout@v4
|
|
|
|
|
with:
|
|
|
|
|
repository: vector-im/element-desktop
|
|
|
|
|
path: element-desktop
|
|
|
|
|
|
|
|
|
|
- name: Fetch element-web
|
|
|
|
|
uses: actions/checkout@v4
|
|
|
|
|
with:
|
|
|
|
|
path: element-web
|
|
|
|
|
|
|
|
|
|
- name: Fetch matrix-react-sdk
|
|
|
|
|
uses: actions/checkout@v4
|
|
|
|
|
with:
|
|
|
|
|
repository: matrix-org/matrix-react-sdk
|
|
|
|
|
path: matrix-react-sdk
|
|
|
|
|
|
|
|
|
|
- name: Setup mdBook
|
|
|
|
|
uses: peaceiris/actions-mdbook@v1
|
|
|
|
|
with:
|
|
|
|
|
mdbook-version: "0.4.10"
|
|
|
|
|
|
|
|
|
|
- name: Install mdbook-combiner
|
|
|
|
|
run: cargo install mdbook-combiner
|
|
|
|
|
|
2023-10-17 09:48:19 +02:00
|
|
|
- name: Prepare docs
|
2023-10-17 00:57:03 +02:00
|
|
|
run: |
|
2023-10-17 09:48:19 +02:00
|
|
|
mkdir -p docs/element-{desktop,web} docs/matrix-react-sdk
|
|
|
|
|
|
|
|
|
|
mv element-desktop/docs "docs/element-desktop/Element Desktop"
|
|
|
|
|
mv element-desktop/README.md docs/element-desktop/
|
|
|
|
|
|
|
|
|
|
mv element-web/docs "docs/element-web/Element Web"
|
|
|
|
|
mv element-web/README.md docs/element-web/
|
|
|
|
|
|
|
|
|
|
mv matrix-react-sdk/docs "docs/matrix-react-sdk/Matrix React SDK"
|
|
|
|
|
mv matrix-react-sdk/README.md docs/matrix-react-sdk/
|
|
|
|
|
|
2023-10-17 00:57:03 +02:00
|
|
|
mdbook-combiner -m docs
|
2023-10-17 09:36:22 +02:00
|
|
|
mv SUMMARY.md docs/
|
2023-10-17 09:48:19 +02:00
|
|
|
|
|
|
|
|
mv element-web/book.toml .
|
|
|
|
|
|
|
|
|
|
- name: Build docs
|
|
|
|
|
run: mdbook build
|
2023-10-17 00:57:03 +02:00
|
|
|
|
2023-10-17 09:58:27 +02:00
|
|
|
- name: Upload artifact
|
|
|
|
|
uses: actions/upload-pages-artifact@v2
|
2023-10-17 00:57:03 +02:00
|
|
|
with:
|
2023-10-17 09:58:27 +02:00
|
|
|
path: ./book
|
|
|
|
|
|
|
|
|
|
deploy:
|
|
|
|
|
environment:
|
|
|
|
|
name: github-pages
|
|
|
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
|
needs: build
|
|
|
|
|
steps:
|
|
|
|
|
- name: Deploy to GitHub Pages
|
|
|
|
|
id: deployment
|
|
|
|
|
uses: actions/deploy-pages@v2
|
