mirror of
https://github.com/element-hq/matrix-authentication-service.git
synced 2026-05-14 23:25:26 +00:00
Andrew Morgan
81 lines
2.2 KiB
YAML
81 lines
2.2 KiB
YAML
# Copyright 2025 New Vector Ltd.
|
|
#
|
|
# SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
|
|
# Please see LICENSE files in the repository root for full details.
|
|
|
|
name: Build and deploy the documentation
|
|
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
pull_request:
|
|
branches: [main]
|
|
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
env:
|
|
CARGO_TERM_COLOR: always
|
|
CARGO_NET_GIT_FETCH_WITH_CLI: "true"
|
|
|
|
jobs:
|
|
build:
|
|
name: Build the documentation
|
|
runs-on: ubuntu-24.04
|
|
steps:
|
|
- name: Checkout the code
|
|
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
|
|
with:
|
|
persist-credentials: false
|
|
|
|
- name: Install Rust toolchain
|
|
# Install the minimal toolchain, which includes rustc, rustdoc, and cargo
|
|
run: rustup toolchain install stable --profile minimal
|
|
|
|
- name: Setup sccache
|
|
uses: mozilla-actions/sccache-action@7d986dd989559c6ecdb630a3fd2557667be217ad # v0.0.9
|
|
|
|
- name: Install mdbook
|
|
uses: taiki-e/install-action@7ea35f098a7369cd23488403f58be9c491a6c55f # v2
|
|
with:
|
|
tool: mdbook
|
|
|
|
- name: Install Node
|
|
uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0
|
|
with:
|
|
node-version: 24
|
|
|
|
- name: Build the documentation
|
|
run: sh misc/build-docs.sh
|
|
|
|
- name: Fix permissions
|
|
run: |
|
|
chmod -c -R +rX "target/book/" | while read line; do
|
|
echo "::warning title=Invalid file permissions automatically fixed::$line"
|
|
done
|
|
|
|
- name: Upload GitHub Pages artifacts
|
|
uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0
|
|
with:
|
|
path: target/book/
|
|
|
|
deploy:
|
|
name: Deploy the documentation on GitHub Pages
|
|
runs-on: ubuntu-24.04
|
|
needs: build
|
|
if: github.ref == 'refs/heads/main'
|
|
|
|
permissions:
|
|
pages: write
|
|
id-token: write
|
|
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
|
|
steps:
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0
|