All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- README: dual workflow example now documents
event == 'push'check for production deployment gates to prevent fork PRs from bypassing branch name conditions.
- Fix Storacha deprecation blog post URL in warning and docs.
- Deprecate Storacha: uploads will stop working on April 15, 2026. A warning is now shown in CI run summary when Storacha credentials are configured. See Storacha announcement.
- Allow Filebase as a standalone CAR upload provider (no longer requires Kubo or IPFS Cluster alongside it).
- Migrate from deprecated
@web3-storage/w3clito@storacha/cli. Existing workflows continue to work without changes.
- Add support for using ipfs-deploy-action in workflows triggered by
workflow_runevents to allow secure usage in PRs from forks.
- Add optional
github-status-gwinput to allow for customizing the gateway used for the commit status updates.
- Add
set-pr-commentinput to control PR comment creation separately from GitHub commit status
- Fix bug where GitHub commit status was still being set when
set-github-statuswas set to 'false' - Update descriptions to clarify that string values 'true' and 'false' are expected for boolean inputs
- Fix commit status and PR comment when action is triggered by
pull_request_targetevent. - Fix bug in
ipfs-cluster-ctl-versioninput not being used correctly.
- Add support for time-bound pins in IPFS Cluster via the
cluster-pin-expire-ininput parameter. - Add support for custom pin names via the
pin-nameinput parameter.
- Add
ipfs-add-optionsinput to allow for customizing theipfs addcommand used to merkleize the build into a CAR file.
- Remove dependency on
ipfs-carnpm package, and use kubo instead to create the CAR file, since we need Kubo for pinning anyways.
- Fix bash bug where the debug logging was not being set correctly.
- Add
upload-car-artifactinput which will upload the CAR file as an artifact visible on GitHub Action Summary pages.
- Improve error handling and logging when the action is not configured correctly, like when the folder to deploy is not found or empty.
- Improve formatting of the action summary output.
- Improve formatting of the action summary output.
- Add
dweb.linkandw3s.link(ifstoracha-keyis provided) to the list of preview links.
- Add timeout and retry logic to IPFS Cluster uploads.
- Uploads to IPFS Cluster have a default timeout of 5 minutes.
- If the upload fails, the action will retry by default 3 times with a 5 second delay between attempts.
- The number of retry attempts and timeout can be customized using the
cluster-retry-attemptsandcluster-timeout-minutesinputs.
- Remove duplicate preview link from PR comment.
- Log info to stdout instead of GitHub workflow summary
- Add support for CAR uploads to Kubo via the Kubo RPC API.
- Removed
cluster-upload-timeoutinput as GitHub Actions does not support setting timeout-minutes for steps in composite actions.
- Default for
cluster-upload-timeoutinput is a number instead of a string.
- Make sure that storacha inputs are not required by action to allow for IPFS Cluster only deployments (inputs will be validated at the beginning of the action ensuring that either Storacha or IPFS Cluster inputs are provided).
- Add support for IPFS Cluster CAR uploads.
- Add
cluster-upload-timeoutinput to set the timeout for IPFS Cluster CAR uploads.
- Storacha is now optional. You can now choose to upload the build CAR to IPFS Cluster instead.
- Fix action step summary output from Merkleizing into CAR step.
- Initial release of of the ipfs-deploy-action