v3 - w3up edition

Rewrite of add-to-web3 action to work with the new w3up web3.storage api.

w3cli does everything we need to upload files to web3.storage, so this action now provides a very thin wrapper around that cli in the form of a composite action.

See the action README.md for more details.

Breaking changes

Auth is based on UCANs now.

Use w3cli to create a signing key for this action to use, and a UCAN proof that delegates upload capabilities to that key.

• input: web3_token has been removed, as token based auth as been removed.
  • set secret_key to a base64 encoded siging key you create via w3 key create.
  • set proof to the a base64 CAR encoded UCAN delegating capabilities to the secret_key's DID.
• input: wrap_with_directory has been removed. w3cli does not wrap directories in directories by default now. Only single files get wrapped to preserve their filename.
  • set wrap: false to disable the wrapping of single files.
• input: web3_api has been removed. Targeting other services is not currently supported. Open an issue if you need that.
• input: include_hidden has been renamed to hidden to match the w3cli flag name

v2.2.0

What's Changed

• fix: update action/core to avoid warnings and add missing output in action.yml by @hugomrdias in #85

New Contributors

• @hugomrdias made their first contribution in #85

Full Changelog: v2.1.0...v2.2.0

v2.1.0 - adds `include_hidden` input option

This release adds an include_hidden input option to allow you to specify that you want files and folders prefixed with a . that we find in the path_to_add to be included in the list of files that get added to web3.storage.

This is useful when you're adding a static website build directory and it contains as a /.well-known path, for example.

Example:

# build your site out to the dist directory (or wherever works for you)
- run: npm run build

# add to web3 with `include_hidden: true`
- uses: web3-storage/[email protected]
  id: web3
  with:
    web3_token: ${{ secrets.WEB3_STORAGE_TOKEN }}
    path_to_add: 'dist'
    include_hidden: true

Many thanks to @ljmf00 for landing this in #38

What's Changed

• feat: Add support for pushing hidden dot files by @ljmf00 in #38
• fix: don't enforce optional parameters to be required by @ljmf00 in #41
• fix: remove trailing whitespace by @ljmf00 in #39
• chore(deps): bump web3.storage from 3.5.2 to 4.2.0 by @dependabot in #55
• chore: update @vercel/ncc and @actions/core by @olizilla in #58
• docs: add include_hidden input option by @olizilla in #59

New Contributors

• @ljmf00 made their first contribution in #38

Full Changelog: v2...v2.1.0

v2.0.0

BREAKING CHANGE: make unixfs importer on ipfs-car use same defaults as lotus (web3-storage/web3.storage#170)

v1.0.0

⁂
web3.storage

Add a directory to web3.storage from an Action, and output it's IPFS Content ID.

Example usage

uses: web3-storage/add-to-web3@v1
id: web3
with:
  web3_token: ${{ secrets.WEB3_STORAGE_TOKEN }}
  path_to_add: 'dist'

# "bafkreicysg23kiwv34eg2d7qweipxwosdo2py4ldv42nbauguluen5v6am"
- run: echo ${{ steps.web3.outputs.cid }}

# "https://dweb.link/ipfs/bafkreicysg23kiwv34eg2d7qweipxwosdo2py4ldv42nbauguluen5v6am"
- run: echo ${{ steps.web3.outputs.url }}