Skip to content

Commit

Permalink
Document the URL base output as well as the mode input.
Browse files Browse the repository at this point in the history
  • Loading branch information
QuintinWillison committed Feb 28, 2023
1 parent a4dba97 commit 255ccd1
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ This action automates the deployment of generated artifacts to our Ably SDK team

## Usage

### Usage After Artifact Generation

See [action.yml](action.yml) for explanations of each input.

```yaml
Expand Down Expand Up @@ -31,6 +33,19 @@ In the above example, `<REPO-NAME>` should be the Ably repository name (e.g. `ab

If `artifactName` is not specified, or specified as an empty string, then artifacts are pushed to the root of the upload context (i.e. dropping `/${artifactName}` from the URL structures outlined above).

### Usage Before Artifact Generation

There are times when the URL base on `sdk.ably.com` needs to be known ahead of artifact build.

This action has an input called `mode` which can be set to `"preempt"` in order to obtain this information up front.

If the preempt mode is requested then nothing will be uploaded to S3, however the action will emit an output called `url-base`,
containing the URL base as a string value. For example:

https://sdk.ably.com/builds/ably/ably-flutter/pull/307/dartdoc/

When used in the Flutter SDK repository, with `artifactName` as `"dartdoc"`.

## Permissions

### AWS
Expand Down

0 comments on commit 255ccd1

Please sign in to comment.