fix: doc images as .webp, naming (#3) #14
This file contains hidden or 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
| # Deployment Job for the Documentation | |
| name: Build & Deploy the Documentation | |
| on: | |
| push: | |
| branches: ["main"] | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| env: | |
| CARGO_TERM_COLOR: always | |
| RUST_VERSION: "1.92.0" | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow only one concurrent deployment, skipping runs queued between the run | |
| # in-progress and latest queued. However, do NOT cancel in-progress runs as we | |
| # want to allow these production deployments to complete. | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| # Build & deploy new version of the documentation | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Install dependencies | |
| run: sudo apt-get install -y python3 python3-pip nodejs npm --no-install-recommends | |
| - name: Install cargo, MyST and cargo-about | |
| run: | | |
| rustup install ${RUST_VERSION} | |
| pip3 install mystmd --break-system-packages | |
| cargo +${RUST_VERSION} install --locked cargo-about | |
| - name: Generate Docs | |
| run: | | |
| cd ./docs && myst build --html --ci --port 3042 && cd ../ | |
| export URL="https://taco-mc.dev" && ./scripts/replace-urls.sh | |
| mkdir -p ./public && mv ./docs/_build/html/* ./public/ | |
| cargo doc --no-deps --document-private-items --workspace | |
| mkdir -p ./public/dev-docs && mv ./target/doc/* ./public/dev-docs/ | |
| cargo about generate --workspace ./.config/about.hbs > third-party-licenses.html | |
| mkdir -p ./public/about && mv third-party-licenses.html ./public/about | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v5 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| # Upload public folder | |
| path: "./public" | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |