ably/SDK Upload
Upload a directory to the Ably SDK Team S3 bucket.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Jun 25, 2026
- License
- Apache 2.0
- Runtime
- Deprecated runtime
Pinned Snippet
uses: ably/sdk-upload-action@4e694297f208b72b5a9f6b1248a1556f19f821d6 # v2.2.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| sourcePath | Path to a directory containing the files to upload, relative to the root directory of the repository. | yes | — |
| githubToken | This should be a token with access to the repository scoped in as a secret. This will be available in the GitHub runner environment by default as `secrets.GITHUB_TOKEN`. | yes | — |
| artifactName | The name of the artifact to be uploaded, for example `docs`. If supplied then it is used as the directory name within S3 for the uploaded artifacts, as well as within the GitHub deployment environment name. If not supplied or supplied as an empty string then the artifacts are uploaded to S3 at root for this deployment context. | no | "" |
| landingPagePath | The extension applied to the baseURL to aid in navigating to the correct page. e.g. if this value is "/documentation/home", then opening a deployment will navigate to this page. | no | "" |
| mode | Specify `"preempt"` in order use this action before content build in order to output the URL base. | no | — |
Outputs
| name | description |
|---|---|
| url-base | The URL base. For example: https://sdk.ably.com/builds/ably/ably-flutter/pull/307/dartdoc/ When used in the Flutter SDK repository, with `artifactName` as `"dartdoc"`. |
| base-path | The base path. For example: /builds/ably/ably-flutter/pull/307/dartdoc/ Useful when needing to know the relative path. |