Update docs.yml #11
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Deploy documentation | |
| on: | |
| push: | |
| branches: [develop] | |
| workflow_dispatch: {} | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| 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: Fetch matrix-js-sdk | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: matrix-org/matrix-js-sdk | |
| path: matrix-js-sdk | |
| - name: Setup mdBook | |
| uses: peaceiris/actions-mdbook@v1 | |
| with: | |
| mdbook-version: "0.4.10" | |
| - name: Install mdbook-combiner | |
| run: cargo install mdbook-combiner | |
| - name: Prepare docs | |
| run: | | |
| mkdir docs | |
| mv element-desktop/README.md element-desktop/docs/ | |
| mv element-desktop/docs "docs/Element Desktop" | |
| mv element-web/README.md element-web/docs/ | |
| mv element-web/docs "docs/Element Web" | |
| 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 | |
| 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 | |
| mv element-web/book.toml . | |
| - name: Build docs | |
| run: mdbook build | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v2 | |
| with: | |
| 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 |