speedlify2/.github/workflows/publish.yml at main · zachleat/speedlify2 · 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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
name: Publish

# Publishing is fully independent of measurement.
#
# The report renders whatever successful data exists at build time, preferring
# the newest per site. It never waits for a measurement pass, never fails
# because a site is missing, and is safe to run at any moment — including while
# measurement jobs are mid-flight.

on:
  schedule:
    # Hourly. Measurement runs on its own cadence; this just publishes the
    # latest state of the dataset.
    - cron: "30 * * * *"
  push:
    branches: [main]
    # Rebuild when data lands or when the site itself changes.
    paths:
      - "results/**"
      - "src/**"
      - "lib/**"
      - "config/**"
      - "eleventy.config.js"
  workflow_dispatch:

# A newer publish supersedes an in-flight one — there is no value in deploying
# a slightly older snapshot after a newer one has started.
concurrency:
  group: publish
  cancel-in-progress: true

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

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
        with:
          node-version: 22
          cache: npm
      - run: npm ci

      # Reports where this site will be served from, which the build needs for
      # absolute URLs. Only sets outputs; the deploy job does the publishing.
      - id: pages
        uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0

      - name: Generate report
        run: node bin/speedlify.js report

      - name: Build
        # The embed snippets need an absolute URL for this instance — someone
        # pastes them onto a different site, where a root-relative path means
        # their own domain. Empty locally, which falls back to a placeholder.
        #
        # `base_path` is the directory Pages will serve this from: empty for a
        # custom domain, "/repo" for a project page. Passing it means neither
        # case has to be guessed, and a fork with a custom domain does not get
        # its repository name wrongly prepended to every URL.
        env:
          SPEEDLIFY_SITE_URL: ${{ steps.pages.outputs.base_url }}
          SPEEDLIFY_BASE_HREF: ${{ steps.pages.outputs.base_path }}
        run: npx @awesome.me/buildawesome

      - name: Report coverage
        # Surfaces how complete the published snapshot is, so a shrinking
        # coverage number is visible in the Actions log rather than only on the
        # rendered page.
        run: node bin/speedlify.js list | tail -3

      - uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
        with:
          path: _site

  deploy:
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deploy.outputs.page_url }}
    steps:
      - id: deploy
        uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0