react-native-firebase/.github/workflows/deploy-api-reference.yml at main · invertase/react-native-firebase · 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
name: Deploy API Reference
on:
  workflow_dispatch:
  workflow_call:

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

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

jobs:
  build-api-reference:
    name: 'Build API Reference'
    runs-on: ubuntu-latest
    steps:
      # https://github.com/actions/checkout/releases
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          fetch-depth: 0
      # https://github.com/actions/setup-node/releases
      - uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
        with:
          node-version: 24
          registry-url: 'https://registry.npmjs.org'
      - name: Install pinned NPM
        # Content-pin via hardcoded dist.integrity (see script).
        # engines: ^22.22.2 || ^24.15.0 || >=26.0.0 (setup-node "24" >=24.15).
        run: bash .github/workflows/scripts/install-pinned-npm.sh

      - name: Yarn Install
        # https://github.com/nick-fields/retry/releases
        uses: nick-fields/retry@ad984534de44a9489a53aefd81eb77f87c70dc60 # v4.0.0
        with:
          timeout_minutes: 15
          retry_wait_seconds: 60
          max_attempts: 3
          command: yarn
      - name: Build API reference (TypeDoc)
        run: yarn reference:api:gh-pages
      - name: Upload API reference artifact
        id: deployment
        # https://github.com/actions/upload-pages-artifact/releases
        uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
        with:
          path: ./apidocs-out

  # Deployment job
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build-api-reference
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        # https://github.com/actions/deploy-pages/releases
        uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5.0.1