publish.yml

name: Publish

on:
  workflow_dispatch:
  push:
    branches:
      - "main"
    paths-ignore:
      - "docs/**"

# GITHUB_TOKEN permissions to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest
    container:
      image: ministryofjustice/tech-docs-github-pages-publisher:v3.0.2
    steps:
    - name: Checkout
      uses: actions/checkout@v3
    - name: Compile Markdown to HTML and create artifact
      run: /scripts/deploy.sh
    - name: Upload artifact to be published
      uses: actions/upload-artifact@v3
      with:
        name: github-pages
        path: artifact.tar
        retention-days: 1

  deploy:
    needs: build
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
    - name: Setup Pages
      uses: actions/configure-pages@v2
    - name: Deploy to GitHub Pages
      id: deployment
      uses: actions/deploy-pages@v1

  url-check:
    needs: deploy
    runs-on: ubuntu-latest
    steps:
    - name: Download a Build Artifact from build
      uses: actions/download-artifact@v3
      with:
        name: github-pages
        path: github-pages
    - name: Unpack files and check URL links
      run: |
        cd github-pages
        tar -xvf artifact.tar
        npm install linkinator
        npx linkinator . --recurse --markdown --skip '\-deploy$'