From 9b019476db7ccb0f4ac84d8e573c8a6f5d6c0ef3 Mon Sep 17 00:00:00 2001 From: Bryan MacFarlane Date: Tue, 24 Sep 2019 21:08:02 -0400 Subject: [PATCH] update commands doc --- docs/commands.md | 48 ++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 44 insertions(+), 4 deletions(-) diff --git a/docs/commands.md b/docs/commands.md index 85be5aee..d4483768 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -9,7 +9,7 @@ your commands. The following commands are all supported: ### Set an environment variable -To set an environment variable, use `::set-env`: +To set an environment variable for future out of process steps, use `::set-env`: ```sh echo ::set-env name=FOO::BAR @@ -17,6 +17,12 @@ echo ::set-env name=FOO::BAR Running `$FOO` in a future step will now return `BAR` +This is wrapped by the core exportVariable method which sets for future steps but also updates the variable for this step + +```javascript +export function exportVariable(name: string, val: string): void {} +``` + ### PATH Manipulation To prepend a string to PATH, use `::addPath`: @@ -27,6 +33,11 @@ echo ::add-path::BAR Running `$PATH` in a future step will now return `BAR:{Previous Path}`; +This is wrapped by the core addPath method: +```javascript +export function addPath(inputPath: string): void {} +``` + ### Set outputs To set an output for the step, use `::set-output`: @@ -46,12 +57,25 @@ steps: run: echo ${{ steps.step_one.outputs.FOO }} ``` -### Masking Values in Logs +This is wrapped by the core setOutput method: -To mask a value in the logs, use `::add-mask`: +```javascript +export function setOutput(name: string, value: string): void {} +``` + +### Register a secret + +If a script or action does work to create a secret at runtime, it can be registered with the runner to be masked in logs. + +To mask a value in the logs, use `::set-secret`: ```sh -echo ::add-mask::BAR +echo ::set-secret::BAR +``` + +This is wrapped by the core method which both sets the value as a variable for future steps and registers the secret to mask +```javascript +function exportSecret(name: string, val: string): void {} ``` Now, future logs containing BAR will be masked. E.g. running `echo "Hello FOO BAR World"` will now print `Hello FOO **** World`. @@ -59,6 +83,22 @@ Now, future logs containing BAR will be masked. E.g. running `echo "Hello FOO BA CAUTION: Do **not** mask short values if you can avoid it, it could render your output unreadable (and future steps' output as well). For example, if you mask the letter `l`, running `echo "Hello FOO BAR World"` will now print `He*********o FOO BAR Wor****d` +### Group and Ungroup Log Lines + +Emitting a group with a title will instruct the logs to create a collapsable region up to the next ungroup command. + +```bash +echo ::group::my title +echo ::ungroup:: +``` + +This is wrapped by the core methods: + +```javascript +function startGroup(name: string): void {} +function endGroup(): void {} +``` + ### Log Level Finally, there are several commands to emit different levels of log output: