element-web/.github/workflows/docs.yml

116 lines
3.5 KiB
YAML
Raw Normal View History

2023-10-16 22:57:03 +00:00
name: Deploy documentation
on:
push:
branches: [develop]
workflow_dispatch: {}
2023-10-17 07:58:27 +00:00
permissions:
contents: read
pages: write
id-token: write
2023-10-17 07:58:27 +00:00
concurrency:
group: "pages"
cancel-in-progress: false
2023-10-17 07:58:27 +00:00
2023-10-16 22:57:03 +00:00
jobs:
2023-10-17 07:58:27 +00:00
build:
2023-10-16 22:57:03 +00:00
name: GitHub Pages
runs-on: ubuntu-latest
steps:
- name: Fetch element-desktop
uses: actions/checkout@v4
with:
2023-12-12 10:31:44 +00:00
repository: element-hq/element-desktop
2023-10-16 22:57:03 +00:00
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: Fetch matrix-js-sdk
uses: actions/checkout@v4
with:
repository: matrix-org/matrix-js-sdk
path: matrix-js-sdk
- uses: actions/setup-node@v4
2023-10-27 13:25:38 +00:00
with:
cache: "yarn"
2023-10-27 14:00:15 +00:00
cache-dependency-path: element-web/yarn.lock
2023-10-27 13:25:38 +00:00
- name: Generate automations docs
working-directory: element-web
run: |
yarn install --frozen-lockfile
2023-10-27 14:04:20 +00:00
yarn ts-node ./scripts/gen-workflow-mermaid.ts ../element-desktop ../element-web ../matrix-react-sdk ../matrix-js-sdk > docs/automations.md
2023-10-27 13:25:38 +00:00
echo "- [Automations](automations.md)" >> docs/SUMMARY.md
2023-10-16 22:57:03 +00:00
- name: Setup mdBook
uses: peaceiris/actions-mdbook@v1
with:
mdbook-version: "0.4.10"
2023-10-26 07:40:33 +00:00
- name: Install mdbook extensions
run: cargo install mdbook-combiner mdbook-mermaid
2023-10-16 22:57:03 +00:00
2023-10-17 07:48:19 +00:00
- name: Prepare docs
2023-10-16 22:57:03 +00:00
run: |
mkdir docs
2023-10-17 07:48:19 +00:00
mv element-desktop/README.md element-desktop/docs/
mv element-desktop/docs "docs/Element Desktop"
2023-10-17 07:48:19 +00:00
mv element-web/README.md element-web/docs/
mv element-web/docs/lib docs/
mv element-web/docs "docs/Element Web"
2023-10-17 07:48:19 +00:00
mv matrix-react-sdk/README.md matrix-react-sdk/docs/
mv matrix-react-sdk/docs "docs/Matrix React SDK"
mv matrix-js-sdk/README.md matrix-js-sdk/docs/
mv matrix-js-sdk/docs "docs/Matrix JS SDK"
sed -i -e 's/\.\.\/README.md/README.md/' docs/**/SUMMARY.md
2023-10-17 07:48:19 +00:00
2023-10-16 22:57:03 +00:00
mdbook-combiner -m docs
sed -i -E 's/^\t# (.+)$/- [\1]()/gm;t' SUMMARY.md
sed -i -E 's/^- \[(.+)]\(<>\)$/---\n# \1/gm;t' SUMMARY.md
sed -i -E 's/\t- \[Introduction]/- [Introduction]/gm;t' SUMMARY.md
cat <<EOF > docs/SUMMARY.md
# Summary
- [Introduction](<Element Web/README.md>)
EOF
cat SUMMARY.md >> docs/SUMMARY.md
2023-10-17 07:48:19 +00:00
mv element-web/book.toml .
- name: Build docs
run: mdbook build
2023-10-16 22:57:03 +00:00
2023-10-17 07:58:27 +00:00
- name: Upload artifact
2024-01-10 10:20:33 +00:00
uses: actions/upload-pages-artifact@v3
2023-10-16 22:57:03 +00:00
with:
2023-10-17 07:58:27 +00: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@v4