feat: Publish static reports via github pages

.github/workflows/build-and-publish-reports.yml

@@ -1,6 +1,16 @@
 name: Build and publish compliance reports
 on:
   workflow_dispatch:
+    inputs:
+      type:
+        description: 'Emulate either schedule, push, or pull_request'
+        required: true
+        default: 'schedule'
+        type: choice
+        options:
+        - schedule
+        - push
+        - pull_request
   schedule:
     - cron: "0 0 * * 6" # Run at 00:00 on every saturday
   push:
@@ -10,57 +20,176 @@ on:
   pull_request:
     branches: [ main ]
 jobs:
-  build-and-publish:
-    if: secrets.PINATA_API_ENDPOINT != null && secrets.PINATA_API_TOKEN != null && secrets.ESTUARY_API_ENDPOINT != null && secrets.ESTUARY_API_TOKEN != null && secrets.NFT_API_ENDPOINT != null && secrets.NFT_API_TOKEN != null && secrets.WEB3_API_ENDPOINT != null && secrets.PINATA_API_TOKEN != null
-    strategy:
-      fail-fast: false
-      matrix:
-        service: [pinata, estuary, nft, web3]
-        include:
-          - service: pinata
-            endpoint: ${{ secrets.PINATA_API_ENDPOINT }}
-            token: ${{secrets.PINATA_API_TOKEN}}
-          - service: estuary
-            endpoint: ${{ secrets.ESTUARY_API_ENDPOINT }}
-            token: ${{secrets.ESTUARY_API_TOKEN}}
-          - service: nft
-            endpoint: ${{ secrets.NFT_API_ENDPOINT }}
-            token: ${{secrets.NFT_API_TOKEN}}
-          - service: web3
-            endpoint: ${{ secrets.WEB3_API_ENDPOINT }}
-            token: ${{secrets.WEB3_API_TOKEN}}
+  checkout:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v3
+      - uses: ipfs/aegir/actions/cache-node-modules@master
 
-    concurrency: ci-${{ github.ref }} # Recommended if you intend to make multiple deployments in quick succession.
+  pinata-compliance-checks:
     runs-on: ubuntu-latest
+    needs: [checkout]
     steps:
       - name: Checkout 🛎️
         uses: actions/checkout@v3
+      - uses: ipfs/aegir/actions/cache-node-modules@master
+      - name: Reports Cache
+        uses: actions/cache@v3
+        with:
+          path: docs
+          key: ${{ github.sha }}-pinata
+      - run: npm run dev-start -- -s ${{ secrets.PINATA_API_ENDPOINT }} ${{secrets.PINATA_API_TOKEN}}
+      - uses: actions/upload-artifact@v2
+        with:
+          name: pinata-logs
+          path: docs/api.pinata.cloud
+      - uses: actions/upload-artifact@v2
+        with:
+          name: pinata-report
+          path: docs/api.pinata.cloud.md
 
-      - name: Install dependencies
-        run: npm ci
+  estuary-compliance-checks:
+    runs-on: ubuntu-latest
+    needs: [checkout]
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v3
+      - uses: ipfs/aegir/actions/cache-node-modules@master
+      - name: Reports Cache
+        uses: actions/cache@v3
+        with:
+          path: docs
+          key: ${{ github.sha }}-estuary
+      - run: npm run dev-start -- -s ${{ secrets.ESTUARY_API_ENDPOINT }} ${{secrets.ESTUARY_API_TOKEN}}
+      - uses: actions/upload-artifact@v2
+        with:
+          name: estuary-logs
+          path: docs/api.estuary.tech
+      - uses: actions/upload-artifact@v2
+        with:
+          name: estuary-report
+          path: docs/api.estuary.tech.md
+
+  nft-compliance-checks:
+    runs-on: ubuntu-latest
+    needs: [checkout]
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v3
+      - uses: ipfs/aegir/actions/cache-node-modules@master
+      - name: Reports Cache
+        uses: actions/cache@v3
+        with:
+          path: docs
+          key: ${{ github.sha }}-nft
+      - run: npm run dev-start -- -s ${{ secrets.NFT_API_ENDPOINT }} ${{secrets.NFT_API_TOKEN}}
+      - uses: actions/upload-artifact@v2
+        with:
+          name: nft-logs
+          path: docs/nft.storage
+      - uses: actions/upload-artifact@v2
+        with:
+          name: nft-report
+          path: docs/nft.storage.md
 
-      # Migrate reports to use npx
-      - name: Generate reports
-        run: npm dev-start -- -s ${{ secrets[matrix.endpoint] }} ${{ secrets[matrix.token] }}
+  web3-compliance-checks:
+    runs-on: ubuntu-latest
+    needs: [checkout]
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v3
+      - uses: ipfs/aegir/actions/cache-node-modules@master
+      - name: Reports Cache
+        uses: actions/cache@v3
+        with:
+          path: docs
+          key: ${{ github.sha }}-web3
+      - run: npm run dev-start -- -s ${{ secrets.WEB3_API_ENDPOINT }} ${{secrets.WEB3_API_TOKEN}}
+      - uses: actions/upload-artifact@v2
+        with:
+          name: web3-logs
+          path: docs/api.web3.storage
+      - uses: actions/upload-artifact@v2
+        with:
+          name: web3-report
+          path: docs/api.web3.storage.md
 
-      # Deploy to gh pages branch
+  # Deploy to gh pages branch
 
-      ## Cron jobs
+  ## Cron jobs
+  deploy-from-schedule:
+    if: success() && (github.event.schedule != null || github.event.pusher != null || github.event.inputs.type == 'schedule' || github.event.inputs.type == 'push')
+    runs-on: ubuntu-latest
+    needs: [pinata-compliance-checks, estuary-compliance-checks, nft-compliance-checks, web3-compliance-checks]
+    concurrency: ci-${{ github.ref }} # Recommended if you intend to make multiple deployments in quick succession.
+    steps:
+      - name: Reports Cache
+        uses: actions/cache@v3
+        with:
+          path: docs
+          key: ${{ github.sha }}-pinata
+      - name: Reports Cache
+        uses: actions/cache@v3
+        with:
+          path: docs
+          key: ${{ github.sha }}-estuary
+      - name: Reports Cache
+        uses: actions/cache@v3
+        with:
+          path: docs
+          key: ${{ github.sha }}-nft
+      - name: Reports Cache
+        uses: actions/cache@v3
+        with:
+          path: docs
+          key: ${{ github.sha }}-web3
       - name: Scheduled deployment
-        if: success() && (github.event.schedule != null || github.event.pusher != null)
         uses: s0/git-publish-subdir-action@399aab378450f99b7de6767f62b0d1dbfcb58b53
         env:
           REPO: self
           BRANCH: gh-pages
           FOLDER: docs
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      ## PRs should push to branch other than primary `gh-pages` branch
-      - name: Deployment for PR
-        if: success() && github.event.pull_request != null
-        uses: s0/git-publish-subdir-action@399aab378450f99b7de6767f62b0d1dbfcb58b53
-        env:
-          REPO: self
-          BRANCH: gh-pages-${github.sha}
-          FOLDER: docs
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  # ## PRs should push to branch other than primary `gh-pages` branch
+  # deploy-from-PR:
+  #   if: success() && github.event.pull_request != null
+  #   runs-on: ubuntu-latest
+  #   needs: [pinata-compliance-checks, estuary-compliance-checks, nft-compliance-checks, web3-compliance-checks]
+  #   concurrency: ci-${{ github.ref }} # Recommended if you intend to make multiple deployments in quick succession.
+  #   steps:
+  #     - name: Reports Cache
+  #       uses: actions/cache@v3
+  #       with:
+  #         path: docs
+  #         key: ${{ github.sha }}-pinata
+  #     - name: Reports Cache
+  #       uses: actions/cache@v3
+  #       with:
+  #         path: docs
+  #         key: ${{ github.sha }}-estuary
+  #     - name: Reports Cache
+  #       uses: actions/cache@v3
+  #       with:
+  #         path: docs
+  #         key: ${{ github.sha }}-nft
+  #     - name: Reports Cache
+  #       uses: actions/cache@v3
+  #       with:
+  #         path: docs
+  #         key: ${{ github.sha }}-web3
+  #     - name: Create branch for PR
+  #       uses: peterjgrainger/[email protected]
+  #       env:
+  #         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  #       with:
+  #         branch: gh-pages-${{ github.sha }}
+  #         # sha: '${{ github.sha }}'
+  #     - name: Deployment for PR
+  #       uses: s0/git-publish-subdir-action@399aab378450f99b7de6767f62b0d1dbfcb58b53
+  #       env:
+  #         REPO: self
+  #         BRANCH: gh-pages-${{ github.sha }}
+  #         FOLDER: docs
+  #         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

src/output/getExpectationsMarkdown.ts

@@ -14,7 +14,7 @@ const getExpectationsMarkdown = <T extends PinsApiResponseTypes>(details: Compli
 
   return `### Expectations (${successes}/${checks} successful)
 
-  ${lineItems.join('\n  ')}
+  ${lineItems.join('\n\n  ')}
 `
 }
 

src/output/getHeader.ts

@@ -21,7 +21,7 @@ const getHeader = <T extends PinsApiResponseTypes>(details: Array<RequiredHeader
 
 ## Summary (${successes}/${checks} successful)
 
-  ${titles.join('\n  ')}
+  ${titles.join('\n\n  ')}
 
 `
 }

src/utils/fetchSafe/getText.ts

@@ -9,7 +9,13 @@ const handleLargeRequests = async () => await sleep(TIMEOUT_SECONDS * 1000).then
 const getText = async <T extends PinsApiResponseTypes>(response: ApiCall<T>['response']): Promise<string> => {
   const actualTextPromise = new Promise((resolve, reject) => {
     response.clone().text().then((result) => {
-      resolve(result)
+      try {
+        const obj = JSON.parse(result)
+        const text = JSON.stringify(obj, null, 2)
+        resolve(text)
+      } catch {
+        resolve(result)
+      }
     }, (error) => {
       reject(error)
     })