ipfs-action

README

ipfs-action

IPFS upload GitHub Action. It allows uploading DApps or content to IPFS in a GitHub pipeline.

Inputs

Parameter	Required	Description
path	Yes	Directory's path to upload.
service	No	Type of target service to upload. Supported services [ipfs, pinata]. Default ipfs
host	No	IPFS host. Default ipfs.komputing.org
port	No	IPFS host's port. Default 443
protocol	No	IPFS host's protocol. Default https
timeout	No	Request timeout. Default 60000 (1 minute)
pinataKey	No	Pinata Api Key. Required for pinata service.
pinataSecret	No	Pinata Secret Api Key. Required for pinata service.
verbose	No	Level of verbosity [false - quiet, true - verbose]. Default false

Outputs

hash - IPFS root's hash.

Documentation

Take a look DApps Delivery Guide

Examples

1. IPFS starter

uses: aquiladev/ipfs-action@v1
with:
  path: ./

2. IPFS with output and params

uses: aquiladev/ipfs-action@v1
id: ipfs
with:
  path: ./build
  host: ipfs.komputing.org
  port: 443
  protocol: https
  timeout: 180000
  verbose: true

3. Pinata starter

uses: aquiladev/ipfs-action@v1
with:
  path: ./build
  service: pinata
  pinataKey: ${{ secrets.PINATA_KEY }}
  pinataSecret: ${{ secrets.PINATA_SECRET }}