chore: add inline comments regarding pagefind and linux #994
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: ci | |
on: | |
pull_request: | |
push: | |
branches: | |
- main | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
jobs: | |
build: | |
# Building on macos because pagefind cannot be installed on ubuntu-latest. | |
# https://github.com/CloudCannon/pagefind/issues/574 | |
runs-on: macos-latest | |
steps: | |
- name: 📚 Git Checkout | |
uses: actions/checkout@v4 | |
- name: 📦 Build Docs | |
uses: ./.github/actions/astro_site | |
deploy: | |
needs: build | |
# Deploying on macos because pagefind cannot be installed on ubuntu-latest. | |
# https://github.com/CloudCannon/pagefind/issues/574 | |
runs-on: macos-latest | |
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
steps: | |
- name: 🚀 Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 | |
spell-check: | |
uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/spell_check.yml@v1 | |
with: | |
includes: | | |
**/*.md | |
**/*.mdx | |
modified_files_only: false |