Practical overview
When it fits
Use it when a GitHub Actions workflow needs to upload a chosen path to Storacha/IPFS and make the resulting content address available to later steps.
Who it is for
- Developers maintaining GitHub Actions workflows that publish website build output or other files to Storacha/IPFS.
- Teams that want later workflow steps to receive the uploaded content’s CID or gateway URL.
Documented uses
- Upload a generated directory such as `dist` from a GitHub Actions workflow.
- Upload a selected file or other content path.
- Pass the resulting CID or gateway URL to subsequent workflow steps.
Requirements & limits
The action requires a Storacha signing key and UCAN proof as inputs. The repository is MIT-licensed.
- The action wraps the Storacha CLI rather than building the content or managing all later publishing steps.
- The
path_to_addinput is required;secret_keyandproofare also required. - The generated proof delegates
space/blob/add,space/index/add,filecoin/offer, andupload/add; it does not permit listing uploads. - The
hiddenoption defaults to false. Thewrapoption defaults to true for a file path.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Add a Storacha upload step to a GitHub Actions workflow
Configure the documented action inputs for a path and make its CID and gateway URL available to later workflow steps.
Before you start
- A GitHub Actions workflow.
- A directory or file to upload.
- A Storacha signing key and proof stored as repository secrets.
Steps
Add
uses: storacha/add-to-web3@v4with an action ID such asstoracha.Set
path_to_addto the content path and provide the repository secrets throughsecret_keyandproof.Reference
steps.storacha.outputs.cidorsteps.storacha.outputs.urlin subsequent workflow steps.
Expected outcome
The workflow is configured to upload the selected content and expose the returned IPFS CID and gateway URL to later steps.
Guide limitations
- This action handles upload configuration and invocation; building the content and any later workflow tasks are separate.
- The documented proof does not grant permission to list uploads.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 14 October 2026
- Original website title
- storacha/add-to-web3 · Official homepage title · retained in its source language

