engineering-learning-hub/.github/workflows/deploy.yml at develop · dineshbyte/engineering-learning-hub · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
name: Build & Deploy

# Flow: feature branch -> PR -> develop -> PR -> main.
# - PRs into develop or main run build + validate ONLY (no deploy), so errors
#   are caught before merge.
# - Deploy to GitHub Pages happens ONLY on push to main (i.e. when a PR merges
#   into main). It never runs on PRs, and never on develop.

on:
    push:
        branches: [main]
    pull_request:
        branches: [main, develop]
    workflow_dispatch:

permissions:
    contents: read
    pages: write
    id-token: write

# One deployment at a time; don't cancel an in-progress deploy on main.
concurrency:
    group: pages-${{ github.ref }}
    cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}

jobs:
    build:
        name: Build & validate
        runs-on: ubuntu-latest
        steps:
            - uses: actions/checkout@v4

            - uses: pnpm/action-setup@v4
              with:
                  version: 10 # any pnpm 10 satisfies the lockfile; bump to match local if needed

            - uses: actions/setup-node@v4
              with:
                  node-version: 22
                  cache: pnpm

            - name: Install dependencies
              run: pnpm install --frozen-lockfile

            - name: Build site
              run: pnpm build

            - name: Validate content (SEO, structured-data, sitemap)
              run: node scripts/validate-content.cjs

            - name: Check internal links
              run: node scripts/check-broken-links.cjs

            - name: Upload Pages artifact
              uses: actions/upload-pages-artifact@v3
              with:
                  path: docs/

    deploy:
        name: Deploy to GitHub Pages
        needs: build
        # Only deploy on pushes to main, never on PRs or other branches.
        if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
        runs-on: ubuntu-latest
        environment:
            name: github-pages
            url: ${{ steps.deployment.outputs.page_url }}
        steps:
            - name: Deploy
              id: deployment
              uses: actions/deploy-pages@v4