docs/.github/workflows/ci.yml at e19e0f7556d76bfa52133b3795d01d723151f4b9 · code-forge-io/docs · 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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
name: 🚀 Validation Pipeline
concurrency:
  group: ${{ github.repository }}-${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
on:
  pull_request:
    branches: [main]

permissions:
  actions: write
  contents: read
  # Required to put a comment into the pull-request
  pull-requests: write
jobs:
  lint:
    name: ⬣ Biome lint
    runs-on: ubuntu-latest
    steps:
      - name: ⬇️ Checkout repo
        uses: actions/checkout@v4
      - name: Setup Biome
        uses: biomejs/setup-biome@v2
      - name: Run Biome
        run: biome ci .

  validate:
    name: 🔎 Validate
    runs-on: ubuntu-latest
    steps:
      - name: 🛑 Cancel Previous Runs
        uses: styfle/cancel-workflow-action@0.12.1
      - name: ⬇️ Checkout repo
        uses: actions/checkout@v4
      - name: ⎔ Setup node
        uses: actions/setup-node@v4
        with:
          node-version-file: "package.json"
      - name: Install pnpm
        uses: pnpm/action-setup@v4
      - name: Install dependencies
        run: pnpm install
      - run: pnpm install --prefer-offline --frozen-lockfile
      - run: pnpm exec playwright install chromium --with-deps
      - name: 🔎 Validate
        run: pnpm run test

  build-docs:
    name: ⬆️ Build Docs
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          ref: ${{ github.head_ref }}
          fetch-depth: 0

      - uses: pnpm/action-setup@v4
      - uses: actions/setup-node@v4
        with:
          node-version-file: "package.json"
          cache: pnpm

      - name: Install deps
        run: pnpm install --prefer-offline --frozen-lockfile

      - name: Generate docs
        #FIXME uncomment if working with monorepo structure
        #  working-directory: docs
        env:
          APP_ENV: production
        run: pnpm run generate:docs

      - name: Pack generated docs (tarball)
			# FIXME adjust if working with monorepo structure
			# run: |
			#   tar -czf docs-generated.tgz -C docs generated-docs
			#   ls -lh docs/docs-generated.tgz
        run: |
          tar -czf docs-generated.tgz generated-docs
          ls -lh docs-generated.tgz

      - name: Upload generated docs (tgz)
        uses: actions/upload-artifact@v4
        with:
          name: docs-generated-tgz
          path: docs-generated.tgz
          if-no-files-found: error

      - name: Upload versions file
        uses: actions/upload-artifact@v4
        with:
          name: docs-versions
					# FIXME adjust if working with monorepo structure
					# path: docs/app/utils/versions.ts
          path: app/utils/versions.ts
          if-no-files-found: error

  deploy-docs-pr-preview:
    name: 🚀 Deploy Docs
    needs: [build-docs]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Download generated docs (tgz)
        uses: actions/download-artifact@v4
        with:
          name: docs-generated-tgz
          path: .

      - name: Unpack generated docs
			# FIXME adjust if working with monorepo structure
			# run: |
			#   set -euxo pipefail
      #   tar -xzf docs-generated.tgz -C docs
      #   ls -laR docs/generated-docs | sed -n '1,200p'
        run: |
          tar -xzf docs-generated.tgz
          ls -laR generated-docs | sed -n '1,200p'

      - name: Download versions file
        uses: actions/download-artifact@v4
        with:
          name: docs-versions
          path: app/utils/

      - uses: forge-42/fly-deploy@v1.0.0-rc.2
        id: deploy
        env:
          FLY_ORG: ${{ vars.FLY_ORG }}
          FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}
          FLY_REGION: ${{ vars.FLY_REGION }}
        with:
					# FIXME uncomment if working with monorepo structure
					# workspace_name: docs
          app_name: ${{ github.event.repository.name }}-${{ github.event.number }}
          use_isolated_workspace: true
          env_vars: |
            APP_ENV=production
            GITHUB_OWNER=${{ github.repository_owner }}
            GITHUB_REPO=${{ github.event.repository.name }}
            GITHUB_REPO_URL=https://github.com/${{ github.repository }}