Merge pull request #228 from vados-cosmonic/fix(ci)=bash-file-check #114
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
| # Sample workflow for building and deploying a mdBook site to GitHub Pages | |
| # | |
| # To get started with mdBook see: https://rust-lang.github.io/mdBook/index.html | |
| # | |
| name: Deploy mdBook site to Pages | |
| on: | |
| # Runs on pushes targeting the default branch | |
| push: | |
| branches: ["main"] | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # 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 | |
| env: | |
| MDBOOK_VERSION: 0.4.21 | |
| MDBOOK_ALERTS_VERSION: 0.6.7 | |
| MDBOOK_LINKCHECK_VERSION: 0.7.7 | |
| PUBLISH_DOMAIN: component-model.bytecodealliance.org | |
| ARTIFACT_PATH: ./component-model/book/html | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Install mdBook | |
| run: | | |
| curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh | |
| rustup update | |
| cargo install --version ${{ env.MDBOOK_VERSION }} mdbook | |
| cargo install --version ${{ env.MDBOOK_ALERTS_VERSION }} mdbook-alerts | |
| cargo install --version ${{ env.MDBOOK_LINKCHECK_VERSION }} mdbook-linkcheck | |
| - name: Build with mdBook | |
| run: mdbook build component-model | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.13' | |
| # Ensure the build generated properly | |
| - name: Ensure build outputs are present | |
| shell: bash | |
| run: | | |
| if [[ ! -f "${{ env.ARTIFACT_PATH }}/index.html" ]]; then | |
| echo "[error] index.html @ [${{ env.ARTIFACT_PATH }}] is missing. Build or path misconfigured"; | |
| exit 1; | |
| fi | |
| - name: Generate sitemap | |
| run: | | |
| cd ${{ env.ARTIFACT_PATH }} | |
| python3 ../scripts/generate_sitemap.py --domain "component-model.bytecodealliance.org" --higher-priority "design" --output-path book/sitemap.xml | |
| cd .. | |
| - name: Setup Pages | |
| id: pages | |
| uses: actions/configure-pages@v3 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: ${{ env.ARTIFACT_PATH }} | |
| # Deployment job | |
| deploy: | |
| if: ${{ github.repository_owner == 'bytecodealliance' }} | |
| 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 |