Skip to content

Publish gh-pages

Publish gh-pages #86

Workflow file for this run

name: Publish gh-pages
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:
name: πŸ— Build application
runs-on: ubuntu-latest
container:
image: ministryofjustice/tech-docs-github-pages-publisher:v3
steps:
- name: Checkout
uses: actions/checkout@v4
- 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:
name: πŸš€ Deploy application
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
check-for-broken-links:
name: πŸ”— Check for broken links
needs: deploy
runs-on: ubuntu-latest
steps:
- name: Download built artifact
uses: actions/download-artifact@v3
with:
name: github-pages
path: github-pages
- name: Unpack built artifact and check for broken links
run: |
cd github-pages
tar -xvf artifact.tar
npm install linkinator
npx linkinator . --recurse --markdown \
--skip https://ministryofjustice.github.io/hmpps-integration-api-docs/images/govuk-large.png \
--skip https://www.cloudflare.com/en-gb/learning/access-management/what-is-mutual-tls/