Merge pull request #1 from centrifuge/add-deployment-to-ipfs

Add IPFS deployment

Author: sophialittlejohn

.github/workflows/publish_to_ipfs.yml

@@ -12,43 +12,25 @@ permissions:
   contents: write
 
 jobs:
-  # For non-main branches, only push to IPFS so we can test it
-  push:
-    runs-on: ubuntu-latest
-    if: github.ref != 'refs/heads/main'
-
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
-        with:
-          node-version: 12.x
-      - run: npm run prepublish
-      - name: Upload to IPFS
-        id: upload_to_ipfs
-        uses: aquiladev/ipfs-action@v0.1.5
-        with:
-          path: ./out/pools.json
-          service: pinata
-          pinataPinName: mainnet-pools-$GITHUB_SHA
-          pinataKey: ${{ secrets.PINATA_KEY }}
-          pinataSecret: ${{ secrets.PINATA_SECRET }}
-
-  # For the main branch, push to IPFS and create a release
-  release:
+  publish:
     runs-on: ubuntu-latest
-    if: github.ref == 'refs/heads/main'
 
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
           node-version: 12.x
-      - run: npm run prepublish
+      - run: |
+          if [[ "${{ github.ref }}" == "refs/heads/main" ]]; then
+          npm run prepublish
+          else
+          npm run prepublish:dev
+          fi
       - name: Upload to IPFS
         id: upload_to_ipfs
         uses: aquiladev/ipfs-action@v0.1.5
         with:
-          path: ./out/pools.json
+          path: ./out/prime.json
           service: pinata
           pinataPinName: mainnet-pools-$GITHUB_SHA
           pinataKey: ${{ secrets.PINATA_KEY }}
@@ -58,6 +40,7 @@ jobs:
         run: |
           echo "::set-output name=sha_short::$(git rev-parse --short HEAD)"
       - name: Create Release
+        if: github.ref == 'refs/heads/main' # only create github release on main branch
         id: create_release
         uses: actions/create-release@v1
         env:
@@ -71,12 +54,13 @@ jobs:
           draft: false
           prerelease: false
       - name: Upload Release Asset
+        if: github.ref == 'refs/heads/main'
         id: upload-release-asset
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           upload_url: ${{ steps.create_release.outputs.upload_url }} # This pulls from the CREATE RELEASE step above, referencing it's ID to get its outputs object, which include a `upload_url`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps
-          asset_path: ./out/pools.json
-          asset_name: pools.json
+          asset_path: ./out/prime.json
+          asset_name: prime.json
           asset_content_type: application/json

README.md

@@ -1,3 +1,13 @@
 # Prime data
 
-Repository for data related to Centrifuge Prime users.
+Repository for data related to Centrifuge Prime users.
+
+## Publishing to IPFS
+
+### Dev
+
+Opening a PR will trigger a deployment of the `dev-data.json` file to IPFS. The new hash can be found in the `Upload to IPFS` step in the [Publish action](https://github.com/centrifuge/prime-data/actions/workflows/publish_to_ipfs.yml).
+
+### Prod
+
+Merging PR to main will trigger a release of the `data.json` file to IPFS. The new hash can be found in the latest [Github release](https://github.com/centrifuge/prime-data/releases).

build.js

@@ -0,0 +1,15 @@
+const fs = require("fs");
+
+const args = process.argv.slice(2);
+const IS_DEV = args[0];
+const primeUsers = require(`./metadata/data${IS_DEV ? "-dev" : ""}.json`);
+
+fs.writeFile(
+  __dirname + "/out/prime.json",
+  JSON.stringify(primeUsers),
+  (err) => {
+    if (err) {
+      throw err;
+    }
+  }
+);

data-dev.json metadata/data-dev.jsondata-dev.json renamed to metadata/data-dev.json

@@ -0,0 +1,15 @@
+{
+  "name": "prime-data",
+  "version": "1.0.0",
+  "description": "Repository for data related to Centrifuge Prime users.",
+  "main": "out/index.js",
+  "scripts": {
+    "prepublish": "npm run build",
+    "prepublish:dev": "npm run build:dev",
+    "build:dev": "mkdir -p out/ && node build.js dev",
+    "build": "mkdir -p out/ && node build.js"
+  },
+  "author": "",
+  "license": "ISC",
+  "packageManager": "yarn@1.22.22+sha1.ac34549e6aa8e7ead463a7407e1c7390f61a6610"
+}