feat!: update to work with w3up api #89

olizilla · 2024-01-16T12:03:31Z

Rewrite of the add-to-web3 github 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.

Breaking changes

Auth is based on UCANs now. Use w3cli to create a signing key for this action to use, and create a ucan that delegates upload abilities 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

Fixes #87

Needs storacha/w3cli#158

License: MIT

Rebuild of the github action to work with the new w3up web3.storage api. [`w3cli`](https://github.com/web3-storage/w3cli) does everything we need to upload files to web3.storage, so this action now provides a thin wrapper around that cli in the form of a composite action. Auth is based on UCANs now. Use w3cli to create a signing key for this action to use, and create a ucan that delegates upload abilities 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 `no_wrap: 'true'` 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. License: MIT Signed-off-by: Oli Evans <oli@protocol.ai>

olizilla · 2024-01-16T12:16:35Z

action.yml

+    - id: get_cid
+      run: echo "::set-output name=cid::$(jq --exit-status --raw-output '.root."/"' ./w3_up_output.json)"
+      shell: bash
+
+    - id: get_url
+      run: echo "::set-output name=url::https://${{ steps.get_cid.outputs.cid }}.ipfs.w3s.link"
+      shell: bash


deprecation warning

Warning: The set-output command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/

License: MIT Signed-off-by: Oli Evans <oli@protocol.ai>

vasco-santos

LGTM! 🎉 small nits in review comments

vasco-santos · 2024-01-16T13:36:34Z

.github/workflows/test.yml

-        web3_api: 'https://api-staging.web3.storage'
-        web3_token: ${{ secrets.WEB3_STORAGE_TOKEN }}
+        proof: ${{ secrets.W3_PROOF }}
+        secret_key: ${{ secrets.W3_PRINCIPAL }}


nit: consider using same names here instead of secret key and principal?

vasco-santos · 2024-01-16T13:38:35Z

README.md


-If you do want to capture the `path_to_add` path itself in the IPFS DAG then you want to set `wrap_with_directory:true`.
+Create using `w3 delegation create --base64`


should we mention in the docs that delegation can be narrowed to a set of capabilities and they should make it only for their needs pointing to the docs https://github.com/web3-storage/w3cli?tab=readme-ov-file#w3-delegation-create-audience-did ?

yeah it is good practice for us to recommend restricting caps.

It may even be a good idea to change this to use limited capability set because this action only uploads no need to give the read access to it.

alanshaw

LGTM, I have left some feedback for your considerations.

README.md

action.yml

alanshaw · 2024-01-16T14:06:54Z

README.md


-If you do want to capture the `path_to_add` path itself in the IPFS DAG then you want to set `wrap_with_directory:true`.
+Create using `w3 delegation create --base64`


yeah it is good practice for us to recommend restricting caps.

README.md

Co-authored-by: Alan Shaw <alan.shaw@protocol.ai>

Gozala

❤️

Gozala · 2024-01-16T17:55:33Z

README.md


-If you do want to capture the `path_to_add` path itself in the IPFS DAG then you want to set `wrap_with_directory:true`.
+Create using `w3 delegation create --base64`


It may even be a good idea to change this to use limited capability set because this action only uploads no need to give the read access to it.

Gozala · 2024-01-16T18:00:37Z

README.md


-Useful for testing against staging deployments by setting to the api origin of your choice.
+Advanced: if `path_to_add` points to a file it will be wrapped in a directory to preserve the filename. To disable that set no_wrap: "true".


Nit: I find no_wrap bit confusing, was wondering maybe it would be better to just make things more explicit by replacing path_to_add with dir_to_add and file_to_add where later could have wrap_file option.

License: MIT Signed-off-by: Oli Evans <oli@protocol.ai>

olizilla added 2 commits January 16, 2024 11:51

Merge branch 'main' into v3

395c2ed

olizilla mentioned this pull request Jan 16, 2024

Need to support new Web3.stoarge API #88

Closed

olizilla requested review from alanshaw and vasco-santos January 16, 2024 12:06

olizilla commented Jan 16, 2024

View reviewed changes

chore: replace deprecated calls to set-output

636dfd4

License: MIT Signed-off-by: Oli Evans <oli@protocol.ai>

vasco-santos approved these changes Jan 16, 2024

View reviewed changes

alanshaw approved these changes Jan 16, 2024

View reviewed changes

docs: Apply suggestions from code review

506ecdf

Co-authored-by: Alan Shaw <alan.shaw@protocol.ai>

Gozala approved these changes Jan 16, 2024

View reviewed changes

gobengo mentioned this pull request Jan 16, 2024

Upgrade to work with w3up #87

Closed

olizilla added 9 commits January 17, 2024 12:00

docs: explain how to generate secret_key and proof from w3cli

2919f32

License: MIT Signed-off-by: Oli Evans <oli@protocol.ai>

chore: tweak copy. test no_wrap

ac0f87e

License: MIT Signed-off-by: Oli Evans <oli@protocol.ai>

fix: no_wrap handling and test

2c07a4e

License: MIT Signed-off-by: Oli Evans <oli@protocol.ai>

chore: fix wrap and hidden args

8fcd052

License: MIT Signed-off-by: Oli Evans <oli@protocol.ai>

fix: interpolation

0dd07c7

License: MIT Signed-off-by: Oli Evans <oli@protocol.ai>

fix: test expectations

70ca455

License: MIT Signed-off-by: Oli Evans <oli@protocol.ai>

chore: test hidden=true

fcfcc0b

License: MIT Signed-off-by: Oli Evans <oli@protocol.ai>

fix: test expectation

a9f7566

License: MIT Signed-off-by: Oli Evans <oli@protocol.ai>

chore: use published w3cli module now fixes are in

89d29ac

License: MIT Signed-off-by: Oli Evans <oli@protocol.ai>

olizilla merged commit 6b67289 into main Jan 17, 2024
1 check passed

olizilla deleted the v3 branch January 17, 2024 16:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: update to work with w3up api #89

feat!: update to work with w3up api #89

olizilla commented Jan 16, 2024 •

edited

Loading

olizilla Jan 16, 2024

vasco-santos left a comment

vasco-santos Jan 16, 2024

vasco-santos Jan 16, 2024

alanshaw Jan 16, 2024

Gozala Jan 16, 2024

alanshaw left a comment

alanshaw Jan 16, 2024

Gozala left a comment

Gozala Jan 16, 2024

Gozala Jan 16, 2024


		If you do want to capture the `path_to_add` path itself in the IPFS DAG then you want to set `wrap_with_directory:true`.
		Create using `w3 delegation create --base64`


		Useful for testing against staging deployments by setting to the api origin of your choice.
		Advanced: if `path_to_add` points to a file it will be wrapped in a directory to preserve the filename. To disable that set no_wrap: "true".

feat!: update to work with w3up api #89

feat!: update to work with w3up api #89

Conversation

olizilla commented Jan 16, 2024 • edited Loading

Breaking changes

Choose a reason for hiding this comment

vasco-santos left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alanshaw left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Gozala left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

olizilla commented Jan 16, 2024 •

edited

Loading