feat: automate releases (#1957)

* chore: add repository to package.json * chore: add changelog * feat: use semantic-release for tags and changelog * feat: make build workflow composable * feat: make test-unit workflow composable * feat: create cached ipfs-webui.car file * feat: make test-e2e workflow composable * feat: make typecheck workflow composable * feat: github workflow updates 1. make eslint workflow commposable 2. generate car file, and cache it, during publishPreview job 3. add cached car file to release artifacts * fix: remove 'needs' from composeable isolated workflows * fix: upload ipfs-webui.car file artifact * fix: remove '@' symbol from car filename * feat: remove .tar.gz * feat: cache ipfs-webui_sha.car file in build dir * feat: pin to estuary and our ipfs-cluster This change also continues on failure for both of the pinning steps, but will fail the job if neither pinning attempt succeeds * fix: revert package-lock.json changes * except for semantic-release required updates * fix: create package-lock.json with [email protected] * tmp * fix: package-lock.json * fix: strict-engines to prevent package-lock issue * fix: github actions use correct engines * fix: distinguish between .car and build contents * debug: test adding semantic-release deps * fix: remove npm install from workflow
ipfs · Jul 8, 2022 · 8bc04ac · 8bc04ac
1 parent e9a0fe2
commit 8bc04ac
Show file tree

Hide file tree

Showing 12 changed files with 53,684 additions and 43,257 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,55 @@
+on:
+  workflow_call:
+
+jobs:
+  build:
+    name: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup node
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16.12.0
+      - name: Setup [email protected]
+        run: |
+          npm install -g [email protected]
+
+      - name: Cache bigger downloads
+        uses: actions/cache@v2
+        id: cache
+        with:
+          path: ${{ github.workspace }}/.cache
+          key: ${{ runner.os }}-${{ hashFiles('package.json', 'package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ hashFiles('package.json', 'package-lock.json') }}
+            ${{ runner.os }}-
+
+      - name: Install dependencies
+        run: npm ci --prefer-offline --no-audit --progress=false --cache ${{ github.workspace }}/.cache/npm
+
+      # Separate cache for build dir, we reuse it in release publish workflow
+      - name: Cache build output
+        if: startsWith(github.ref, 'refs/tags/v')
+        uses: actions/cache@v2
+        id: build-cache
+        with:
+          path: build
+          key: ${{ runner.os }}-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-${{ github.sha }}
+
+      - name: Confirm build works
+        if: steps.build-cache.outputs.cache-hit != 'true'
+        run: npm run build
+
+      # Persist produced build dir:
+      # - this is not for releases, but for quick testing during the dev
+      # - action artifacts can be downloaded for 90 days, then are removed by github
+      - name: Attach produced build to Github Action
+        uses: actions/upload-artifact@v2
+        with:
+          name: ipfs-webui_${{ github.sha }}-build
+          path: build
+          if-no-files-found: error
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -16,64 +16,36 @@ env:
 jobs:
   build:
     name: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Setup node
-        uses: actions/setup-node@v2
-        with:
-          node-version: 16.14.x
-
-      - name: Cache bigger downloads
-        uses: actions/cache@v2
-        id: cache
-        with:
-          path: ${{ github.workspace }}/.cache
-          key: ${{ runner.os }}-${{ hashFiles('package.json', 'package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-${{ hashFiles('package.json', 'package-lock.json') }}
-            ${{ runner.os }}-
-
-      - name: Install dependencies
-        run: npm ci --prefer-offline --no-audit --progress=false --cache ${{ github.workspace }}/.cache/npm
-
-      # Separate cache for build dir, we reuse it in release publish workflow
-      - name: Cache build output
-        if: startsWith(github.ref, 'refs/tags/v')
-        uses: actions/cache@v2
-        id: build-cache
-        with:
-          path: build
-          key: ${{ runner.os }}-${{ github.sha }}
-          restore-keys: |
-            ${{ runner.os }}-${{ github.sha }}
-
-      - name: Confirm build works
-        if: steps.build-cache.outputs.cache-hit != 'true'
-        run: npm run build
-
-      # Persist produced build dir:
-      # - this is not for releases, but for quick testing during the dev
-      # - action artifacts can be downloaded for 90 days, then are removed by github
-      - name: Attach produced build to Github Action
-        uses: actions/upload-artifact@v2
-        with:
-          name: ipfs-webui_${{ github.sha }}
-          path: build
-          if-no-files-found: error
+    uses: ./.github/workflows/build.yml
 
   test-unit:
     name: 'test:unit'
     needs: build
+    uses: ./.github/workflows/test-unit.yml
+
+  publishPreview:
+    name: publish preview
+    needs: build
+    environment: Deploy
     runs-on: ubuntu-latest
+    outputs:
+      cid: ${{ steps.ipfs.outputs.cid }}
     steps:
       - uses: actions/checkout@v2
 
       - name: Setup node
         uses: actions/setup-node@v2
         with:
-          node-version: 16.14.x
+          node-version: 16.12.0
+      - name: Setup [email protected]
+        run: |
+          npm install -g [email protected]
+
+      - name: Download build artifact
+        uses: actions/download-artifact@v2
+        with:
+          name: ipfs-webui_${{ github.sha }}-build
+          path: build
 
       - name: Cache bigger downloads
         uses: actions/cache@v2
@@ -85,31 +57,6 @@ jobs:
             ${{ runner.os }}-${{ hashFiles('package.json', 'package-lock.json') }}
             ${{ runner.os }}-
 
-      - name: Install dependencies
-        run: npm ci --prefer-offline --no-audit --progress=false --cache ${{ github.workspace }}/.cache/npm
-
-      - name: Run unit tests
-        run: npm run test:unit
-
-  publish-preview:
-    name: publish preview
-    needs: build
-    environment: Deploy
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Setup node
-        uses: actions/setup-node@v2
-        with:
-          node-version: 16.14.x
-
-      - name: Download build artifact
-        uses: actions/download-artifact@v2
-        with:
-          name: ipfs-webui_${{ github.sha }}
-          path: build
-
       # pin the built site to ipfs-websites cluster, output the cid as `steps.ipfs.outputs.cid`
       # see: https://github.com/ipfs-shipyard/ipfs-github-action
       - uses: ipfs/download-ipfs-distribution-action@v1
@@ -132,8 +79,30 @@ jobs:
 
       - run: echo ${{ steps.ipfs.outputs.cid }}
       - run: echo ${{ github.ref }}
+      - name: Create ipfs-webui.car file
+        run: |
+          ipfs dag export ${{ steps.ipfs.outputs.cid }} > build/ipfs-webui_${{ github.sha }}.car
+      - name: Attach produced build to Github Action
+        uses: actions/upload-artifact@v2
+        with:
+          name: ipfs-webui_${{ github.sha }}.car
+          path: build/ipfs-webui_${{ github.sha }}.car
+          if-no-files-found: error
+
+      - name: Pin to estuary.tech
+        id: pin-estuary
+        continue-on-error: true
+        run: |
+          curl -X POST https://api.estuary.tech/pinning/pins -d '{ "name": "'$PIN_NAME'", "cid": "'$PIN_CID'" }' -H "Content-Type: application/json" -H "Authorization: Bearer $ESTUARY_API_TOKEN"
+          curl -X GET https://api.estuary.tech/pinning/pins -H "Content-Type: application/json" -H "Authorization: Bearer $ESTUARY_API_TOKEN"
+        env:
+          ESTUARY_API_TOKEN: ${{ secrets.ESTUARY_API_TOKEN }}
+          PIN_CID: ${{ steps.ipfs.outputs.cid }}
+          PIN_NAME: "ipfs-webui@${{ github.sha }}"
 
       - name: Pin to ipfs-websites.collab.ipfscluster.io
+        id: pin-cluster
+        continue-on-error: true
         run: |
           ipfs-cluster-ctl --enc=json \
             --host "${CLUSTER_HOST}" \
@@ -159,6 +128,13 @@ jobs:
           PIN_CID: ${{ steps.ipfs.outputs.cid }}
           PIN_NAME: "ipfs-webui@${{ github.sha }}"
 
+      - name: Fail job due to pinning failure
+        if: steps.pin-estuary.outcome == 'failure' && steps.pin-cluster.outcome == 'failure'
+        uses: actions/github-script@v3
+        with:
+          script: |
+              core.setFailed('Pinning did not succeed')
+
       # dev dnslink is updated on each main branch update
       - run: npx dnslink-dnsimple --domain dev.webui.ipfs.io --link /ipfs/${{ steps.ipfs.outputs.cid }}
         if: github.ref == 'refs/heads/main'
@@ -174,88 +150,34 @@ jobs:
   test-e2e:
     name: 'test:e2e'
     needs: build
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        backend: [go] # TODO: add 'js' – see https://github.com/ipfs/ipfs-webui/issues/1737
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Setup node
-        uses: actions/setup-node@v1
-        with:
-          node-version: 16.14.x
-
-      - name: Cache bigger downloads
-        uses: actions/cache@v2
-        id: cache
-        with:
-          path: ${{ github.workspace }}/.cache
-          key: ${{ runner.os }}-${{ hashFiles('package.json', 'package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-${{ hashFiles('package.json', 'package-lock.json') }}
-            ${{ runner.os }}-
-
-      - name: Install dependencies
-        run: npm ci --prefer-offline --no-audit --progress=false --cache ${{ github.workspace }}/.cache/npm
-
-      - name: Download build artifact
-        uses: actions/download-artifact@v2
-        with:
-          name: ipfs-webui_${{ github.sha }}
-          path: build
-
-      - name: Run E2E against ${{ matrix.backend }}-ipfs
-        run: E2E_IPFSD_TYPE=${{ matrix.backend }} npm run test:e2e
+    uses: ./.github/workflows/test-e2e.yml
 
   # separate check for TS
   typecheck:
     name: typecheck
     needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-
-      - name: Setup node
-        uses: actions/setup-node@v1
-        with:
-          node-version: 16.14.x
-
-      - name: Cache bigger downloads
-        uses: actions/cache@v2
-        id: cache
-        with:
-          path: ${{ github.workspace }}/.cache
-          key: ${{ runner.os }}-${{ hashFiles('package.json', 'package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-${{ hashFiles('package.json', 'package-lock.json') }}
-            ${{ runner.os }}-
-
-      - name: Install dependencies
-        run: npm ci --prefer-offline --no-audit --progress=false --cache ${{ github.workspace }}/.cache/npm
-
-      - name: Fancy Typecheck with GH annotations
-        uses: gozala/[email protected]
-        with:
-          project: tsconfig.json
-
-      # make sure local check is also ok
-      - name: Userland check
-        run: npm run typecheck
+    uses: ./.github/workflows/typecheck.yml
 
   # separate check for eslint
   eslint:
     name: eslint
     needs: build
+    uses: ./.github/workflows/eslint.yml
+
+  # automatically commit new tag and changelog updates when a push to main happens.
+  # This will then trigger
+  #    1. The 'ci.yml' workflow for the newly committed git tag,
+  #    2. The 'publish-release-build.yml' workflow
+  release:
+    name: 'Run semantic release'
+    if: github.ref == 'refs/heads/main'
     runs-on: ubuntu-latest
+    needs: [build, publishPreview, eslint, typecheck, test-e2e, test-unit]
     steps:
-      - uses: actions/checkout@v1
-
-      - name: Setup node
-        uses: actions/setup-node@v1
+      - name: Checkout 🛎️
+        uses: actions/checkout@v2
         with:
-          node-version: 16.14.x
+          persist-credentials: false
 
       - name: Cache bigger downloads
         uses: actions/cache@v2
@@ -267,9 +189,21 @@ jobs:
             ${{ runner.os }}-${{ hashFiles('package.json', 'package-lock.json') }}
             ${{ runner.os }}-
 
-      - name: Install dependencies
-        run: npm ci --prefer-offline --no-audit --progress=false --cache ${{ github.workspace }}/.cache/npm
+      - name: Cache build dir
+        uses: actions/cache@v2
+        id: build-cache
+        with:
+          path: build
+          key: ${{ runner.os }}-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-${{ github.sha }}
 
-      - name: ESLint
-        run: npm run eslint
+      # This is needed for custom-release-notes-generator.js to inject the CID in the release notes
+      - name: Write CID to tmp file
+        run: |
+          echo ${{ needs.publishPreview.outputs.cid }} > .cid
 
+      # Update the version (npm version [major|minor|patch])
+      - name: Run semantic release
+        run: |
+          npx semantic-release --ci
diff --git a/.github/workflows/eslint.yml b/.github/workflows/eslint.yml
@@ -0,0 +1,33 @@
+on:
+  workflow_call:
+
+jobs:
+  eslint:
+    name: eslint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Setup node
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16.12.0
+      - name: Setup [email protected]
+        run: |
+          npm install -g [email protected]
+
+      - name: Cache bigger downloads
+        uses: actions/cache@v2
+        id: cache
+        with:
+          path: ${{ github.workspace }}/.cache
+          key: ${{ runner.os }}-${{ hashFiles('package.json', 'package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ hashFiles('package.json', 'package-lock.json') }}
+            ${{ runner.os }}-
+
+      - name: Install dependencies
+        run: npm ci --prefer-offline --no-audit --progress=false --cache ${{ github.workspace }}/.cache/npm
+
+      - name: ESLint
+        run: npm run eslint