fix: github actions publish compliance check results

* fix: Create index page for github pages

fixes #55

* fix: github pages publishing matrix arg cleanup

* fix: remove npm run setup in github actions

* feat: publish gh-pages-SHA branch for PRs

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

@@ -11,10 +11,24 @@ on:
     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:
-        args: ["${{ secrets.PINATA_API_ENDPOINT }} ${{ secrets.PINATA_API_TOKEN }}", "${{ secrets.ESTUARY_API_ENDPOINT }} ${{ secrets.ESTUARY_API_TOKEN }}", "${{ secrets.NFT_API_ENDPOINT }} ${{ secrets.NFT_API_TOKEN }}", "${{ secrets.WEB3_API_ENDPOINT }} ${{ secrets.WEB3_API_TOKEN }}"]
+        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}}
 
     concurrency: ci-${{ github.ref }} # Recommended if you intend to make multiple deployments in quick succession.
     runs-on: ubuntu-latest
@@ -23,18 +37,30 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Install dependencies
-        run: npm install
-
-      - name: Run setup script
-        run: npm run setup
+        run: npm ci
 
+      # Migrate reports to use npx
       - name: Generate reports
-        run: node -r ts-node/register src/index.ts -s ${{ matrix.args }}
+        run: npm dev-start -- -s ${{ secrets[matrix.endpoint] }} ${{ secrets[matrix.token] }}
+
       # Deploy to gh pages branch
-      - name: Deploy
+
+      ## Cron jobs
+      - 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 }}

docs/index.md

@@ -0,0 +1,8 @@
+# Pinning Service Compliance
+
+## Results
+
+* [Estuary](./api.estuary.tech.md)
+* [Pinata](./api.pinata.cloud.md)
+* [web3.storage](./api.web3.storage.md)
+* [nft.storage](./nft.storage.md)