feat: build next.js and push to ipfs action (#4)

Author: gmolki

.gitignore

@@ -1 +1,2 @@
-.idea
+.idea
+.DS_Store

build-nextjs-app/README.md

@@ -0,0 +1,24 @@
+# Build Next.js App action
+
+This action builds and exports a Next.js app
+
+## Inputs
+
+## `node-version`
+
+Node.js version
+
+## `fa-token`
+
+FontAwesome NPM Auth Token
+
+## `export`
+
+Whether to export the app or not
+
+## Example usage
+
+```yaml
+- name: Build and Export
+  uses: aleph-im/aleph-github-actions/build@v1
+```

build-nextjs-app/action.yaml

@@ -0,0 +1,46 @@
+name: Build
+description: Build and export Next.js app
+
+inputs:
+  node-version:
+    description: 'Node.js version'
+    required: false
+    default: 18
+  fa-token:
+    description: 'FontAwesome NPM Auth Token (optional)'
+    required: false
+    default: ''
+  export:
+    description: 'Whether to export the app as a static site or not'
+    required: false
+    default: true
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Setup Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ inputs.node-version }}
+        cache: npm
+
+    - name: Install dependencies
+      shell: bash
+      env:
+        FONTAWESOME_NPM_AUTH_TOKEN: ${{ inputs.fa-token }}
+      run: npm ci
+
+    - name: Cache
+      uses: actions/cache@v4
+      with:
+        path: .next/cache
+        # Generate a new cache whenever packages or next config changes.
+        key: ${{ runner.os }}-next-build-${{ hashFiles('**/package-lock.json','**/next.config.js') }}
+        restore-keys: |
+          ${{ runner.os }}-next-build-
+
+    - name: Build and export
+      shell: bash
+      env:
+        NEXTJS_EXPORT: ${{ inputs.export }}
+      run: npm run build

push-to-ipfs/README.md

@@ -0,0 +1,24 @@
+# Push to IPFS action
+
+This action performs a pin to Aleph IPFS
+
+## Inputs
+
+## `upload-dir`
+
+**Required** Directory to upload
+
+## Outputs
+
+## `cid`
+
+Generated IPFS CID
+
+## Example usage
+
+```yaml
+- name: Push to IPFS
+  uses: aleph-im/aleph-github-actions/push-to-ipfs@v1
+  with:
+    upload-dir: out
+```

push-to-ipfs/action.yaml

@@ -0,0 +1,23 @@
+name: Push to IPFS
+description: Push directory to IPFS
+
+inputs:
+  upload-dir:
+    description: 'Directory to upload'
+    required: true
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Push to IPFS
+      id: push_to_ipfs
+      shell: bash
+      run: |
+        pip install 'aioipfs>=0.6.2'
+        CID=$(python3 ${{ github.action_path }}/scripts/push_on_ipfs.py "${{ inputs.upload-dir }}")
+        echo "CID: $CID" >> $GITHUB_STEP_SUMMARY
+        echo "cid=$CID" >> $GITHUB_OUTPUT
+outputs:
+  cid:
+    description: 'IPFS CID'
+    value: ${{ steps.push_to_ipfs.outputs.cid }}

push-to-ipfs/scripts/push_on_ipfs.py

@@ -0,0 +1,57 @@
+#!/usr/bin/env python3
+
+"""
+This script uploads the build SPA to IPFS.
+It does not ping it or do anything else yet, so the result can only be accessed
+ as long as the files are not garbage collected.
+Requires: 'aioipfs>=0.6.2'
+"""
+
+import asyncio
+import logging
+from pathlib import Path
+from typing import NewType
+
+import aioipfs
+
+logger = logging.getLogger(__file__)
+
+Multiaddr = NewType("Multiaddr", str)
+CID = NewType("CID", str)
+
+
+def raise_no_cid():
+    raise ValueError("Could not obtain a CID")
+
+
+async def upload_site(files: list[Path], multiaddr: Multiaddr) -> CID:
+    client = aioipfs.AsyncIPFS(maddr=multiaddr)
+
+    try:
+        cid = None
+        async for added_file in client.add(*files, recursive=True):
+            logger.debug(
+                f"Uploaded file {added_file['Name']} with CID: {added_file['Hash']}"
+            )
+            cid = added_file["Hash"]
+        # The last CID is the CID of the directory uploaded
+        return cid or raise_no_cid()
+    finally:
+        await client.close()
+
+
+async def publish_site(multiaddr: Multiaddr) -> CID:
+    path = Path(__file__).parent / "../out"
+    if not path.is_dir():
+        raise NotADirectoryError(f"No such directory: {path}")
+    cid = await upload_site(files=[path], multiaddr=multiaddr)
+    return cid
+
+
+def main():
+    print(asyncio.run(publish_site(Multiaddr("/dns6/ipfs-2.aleph.im/tcp/443/https"))))
+
+
+if __name__ == "__main__":
+    logging.basicConfig(level=logging.INFO)
+    main()