workflow.yml

name: Build package, deploy pages, publish npm package

on:
  # Runs on push to any branch and on pull request merge
  push:

  # 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

jobs:
  # Build
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Setup Node
        uses: actions/setup-node@v4
        with:
          node-version: 20
      - name: Install
        run: npm ci
      - name: Lint
        run: npm run lint
      - name: Test
        run: npm run test
      - name: Build
        run: npm run build
      - name: Upload lib artifact
        uses: actions/upload-artifact@v4
        with:
          name: lib
          path: lib
      - name: Upload build artifact
        uses: actions/upload-artifact@v4
        with:
          name: build
          path: build

  # Check if this is 'main' branch
  main-branch:
    needs: [build]
    if: github.ref == 'refs/heads/main' # Only run on main branch
    runs-on: ubuntu-latest
    steps: 
      - name: Echo OK
        run: echo OK

  # Build pages
  build-pages:
    needs: [main-branch]
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Download build artifact
        uses: actions/download-artifact@v4
        with:
          name: build
          path: build
      - name: Setup Pages
        uses: actions/configure-pages@v5
      - name: Build with Jekyll
        uses: actions/jekyll-build-pages@v1
        with:
          source: ./
          destination: ./_site
      - name: Upload pages artifact
        uses: actions/upload-pages-artifact@v3

  # Deploy pages
  deploy-pages:
    needs: [build-pages]
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4

  # Check tag validity before publishing
  valid-tag:
    needs: [build]
    if: github.ref_type == 'tag'
    runs-on: ubuntu-latest
    steps:
    - name: Check that the tag follows semantic versioning with "v" prefix
      run: echo ${{ github.ref_name }} | egrep '^v[0-9]+\.[0-9]+\.[0-9]+\S*$'

  # Publish to npm
  npm-publish:
    needs: [valid-tag]
    runs-on: ubuntu-latest
    steps:
        - uses: actions/checkout@v4
        - uses: actions/setup-node@v4
          with:
            node-version: 20
            registry-url: https://registry.npmjs.org/
        - name: Download lib artifact
          uses: actions/download-artifact@v4
          with:
            name: lib
            path: lib
        - name: Download build artifact
          uses: actions/download-artifact@v4
          with:
            name: build
            path: build
        - name: NPM Publish
          run: npm publish
          env:
            NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}