From 255ccd1f7066b2b7adea32016efed5b384b694fb Mon Sep 17 00:00:00 2001 From: Quintin Willison Date: Tue, 28 Feb 2023 09:33:26 +0000 Subject: [PATCH] Document the URL base output as well as the mode input. --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 585c778..06e8b6a 100644 --- a/README.md +++ b/README.md @@ -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 @@ -31,6 +33,19 @@ In the above example, `` 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