Split link checking into its own job (#1551) #5374
Workflow file for this run
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: Zola | |
| on: | |
| push: | |
| branches: source | |
| pull_request: | |
| jobs: | |
| zola: | |
| runs-on: ubuntu-latest | |
| env: | |
| BASE_URL: https://github.com/getzola/zola/releases/download | |
| VERS: v0.19.1 | |
| ARCH: x86_64-unknown-linux-gnu | |
| # https://github.com/crazy-max/ghaction-github-pages/issues/1#issuecomment-623202206 | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Lint | |
| uses: avto-dev/markdown-lint@v1 | |
| with: | |
| args: '.' | |
| config: '.markdownlint.json' | |
| - name: Install Zola | |
| run: | | |
| curl -L ${BASE_URL}/${VERS}/zola-${VERS}-${ARCH}.tar.gz | tar -xz | |
| echo "Zola version: $(./zola --version)" | |
| - name: Zola build | |
| run: ./zola build | |
| - name: Upload GitHub Pages artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: public | |
| links: | |
| name: Check for Broken Links | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: ${{ github.event_name == 'pull_request' && 2 || 0 }} | |
| - name: Get changed files | |
| id: changed-files | |
| # source: https://stackoverflow.com/a/74268200, added filtering for markdown files | |
| run: | | |
| if ${{ github.event_name == 'pull_request' }}; then | |
| changed_files=$(git diff --name-only -r HEAD^1 HEAD -z | grep '\.md$' -zZ | xargs -0) | |
| else | |
| changed_files=$(git diff --name-only ${{ github.event.before }} ${{ github.event.after }} -z | grep '\.md$' -zZ | xargs -0) | |
| fi | |
| echo "changed_files: $changed_files" | |
| echo "changed_files=$changed_files" >> $GITHUB_OUTPUT | |
| - name: Check links | |
| uses: lycheeverse/[email protected] | |
| if: ${{ steps.changed-files.outputs.changed_files != '' }} | |
| with: | |
| fail: true | |
| args: >- | |
| --verbose | |
| --no-progress | |
| --accept '100..=103,200..=299,300..=399' | |
| --exclude '[^\w]todo[^\w]?' | |
| --exclude 'https://(www\.|old\.)?reddit\.com' | |
| --exclude 'https://www.patreon.com' | |
| --exclude 'https://gamedev.social' | |
| --exclude 'dev.epicgames.com' | |
| --exclude-path 'assets/logo/readme.md' | |
| ${{ steps.changed-files.outputs.changed_files }} | |
| pages: | |
| needs: zola | |
| permissions: | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| if: format('refs/heads/{0}', github.event.repository.default_branch) == github.ref | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |