From 8c74e279d8f827bedc3d2ab6567a9398d682d5c9 Mon Sep 17 00:00:00 2001 From: Nikola Jokic <97525037+nikola-jokic@users.noreply.github.com> Date: Wed, 23 Feb 2022 15:26:26 +0100 Subject: [PATCH 1/7] Added explanation that everything passed through args will be passed to the container --- .../creating-actions/creating-a-docker-container-action.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/actions/creating-actions/creating-a-docker-container-action.md b/content/actions/creating-actions/creating-a-docker-container-action.md index 049b7b0208..9e4611b6ed 100644 --- a/content/actions/creating-actions/creating-a-docker-container-action.md +++ b/content/actions/creating-actions/creating-a-docker-container-action.md @@ -96,7 +96,7 @@ runs: ``` {% endraw %} -This metadata defines one `who-to-greet` input and one `time` output parameter. To pass inputs to the Docker container, you must declare the input using `inputs` and pass the input in the `args` keyword. +This metadata defines one `who-to-greet` input and one `time` output parameter. To pass inputs to the Docker container, you should declare the input using `inputs` and pass the input in the `args` keyword. Everything you pass to the `args` will be passed to the container, but for readability purposes, it is best practice to use inputs. {% data variables.product.prodname_dotcom %} will build an image from your `Dockerfile`, and run commands in a new container using this image. From 84f5fe12e5be72825df9c99ec6d73353c5b4e86d Mon Sep 17 00:00:00 2001 From: Benjamin Martin Date: Tue, 1 Mar 2022 19:10:22 -0500 Subject: [PATCH 2/7] Add details about required scopes for Self-Hosted Runner --- .../autoscaling-with-self-hosted-runners.md | 1 + 1 file changed, 1 insertion(+) diff --git a/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md b/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md index 7472d9786b..c409368b1d 100644 --- a/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md @@ -91,6 +91,7 @@ Your access token will require the following scope: - For private repositories, use an access token with the [`repo` scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes). - For public repositories, use an access token with the [`public_repo` scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes). +- For organizations, use an access token with the [`admin:org` scope](/rest/reference/actions#get-a-self-hosted-runner-for-an-organization). To authenticate using a {% data variables.product.prodname_dotcom %} App, it must be assigned the following permissions: - For repositories, assign the `administration` permission. From 40a7ad71367d5f19536a2e85271e01f574012042 Mon Sep 17 00:00:00 2001 From: Nikola Jokic <97525037+nikola-jokic@users.noreply.github.com> Date: Tue, 15 Mar 2022 11:03:32 +0100 Subject: [PATCH 3/7] Added explanation about masking outputs --- .../using-workflows/workflow-commands-for-github-actions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/actions/using-workflows/workflow-commands-for-github-actions.md b/content/actions/using-workflows/workflow-commands-for-github-actions.md index d9c7e21aa1..99f8b6d59a 100644 --- a/content/actions/using-workflows/workflow-commands-for-github-actions.md +++ b/content/actions/using-workflows/workflow-commands-for-github-actions.md @@ -190,7 +190,7 @@ echo "::endgroup::" ::add-mask::{value} ``` -Masking a value prevents a string or variable from being printed in the log. Each masked word separated by whitespace is replaced with the `*` character. You can use an environment variable or string for the mask's `value`. +Masking a value prevents a string or variable from being printed in the log. Each masked word separated by whitespace is replaced with the `*` character. You can use an environment variable or string for the mask's `value`. Masked outputs are considered as secrets, and will be redacted on the runner. See [Workflow commands for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions). ### Example masking a string From 49243a34b1a200efd9e3f2561a4e758d5f93da49 Mon Sep 17 00:00:00 2001 From: Christian Koop Date: Tue, 15 Mar 2022 14:22:11 +0100 Subject: [PATCH 4/7] Fixes output of wrong input variable in reusable `github.event.inputs.tag` is never set but `.tags` is. I changed the output text from singular to plural and changed the used input variable to the correct one --- data/reusables/actions/workflow-dispatch-inputs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/reusables/actions/workflow-dispatch-inputs.md b/data/reusables/actions/workflow-dispatch-inputs.md index 6060e4ad50..f4612814b7 100644 --- a/data/reusables/actions/workflow-dispatch-inputs.md +++ b/data/reusables/actions/workflow-dispatch-inputs.md @@ -34,5 +34,5 @@ jobs: if: {% raw %} ${{ github.event.inputs.print_tags == 'true' }} {% endraw %} steps: - name: Print the input tag to STDOUT - run: echo {% raw %} The tag is ${{ github.event.inputs.tag }} {% endraw %} + run: echo {% raw %} The tags are ${{ github.event.inputs.tags }} {% endraw %} ``` From 8fb1216e7700137c67a0b891fa6c10cc648a9b19 Mon Sep 17 00:00:00 2001 From: Lucas Costi Date: Mon, 28 Mar 2022 16:20:05 +1000 Subject: [PATCH 5/7] Update content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md --- .../autoscaling-with-self-hosted-runners.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md b/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md index d8853afb52..6e20859156 100644 --- a/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md @@ -91,7 +91,7 @@ Your access token will require the following scope: - For private repositories, use an access token with the [`repo` scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes). - For public repositories, use an access token with the [`public_repo` scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes). -- For organizations, use an access token with the [`admin:org` scope](/rest/reference/actions#get-a-self-hosted-runner-for-an-organization). +- For organizations, use an access token with the [`admin:org` scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes). To authenticate using a {% data variables.product.prodname_dotcom %} App, it must be assigned the following permissions: - For repositories, assign the `administration` permission. From 98b52f2f658452f432e6a9bbf2b5b309911773c0 Mon Sep 17 00:00:00 2001 From: Nikola Jokic <97525037+nikola-jokic@users.noreply.github.com> Date: Mon, 28 Mar 2022 09:17:44 +0200 Subject: [PATCH 6/7] Update content/actions/creating-actions/creating-a-docker-container-action.md Co-authored-by: Lucas Costi --- .../creating-actions/creating-a-docker-container-action.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/actions/creating-actions/creating-a-docker-container-action.md b/content/actions/creating-actions/creating-a-docker-container-action.md index 9e4611b6ed..367d8b9bda 100644 --- a/content/actions/creating-actions/creating-a-docker-container-action.md +++ b/content/actions/creating-actions/creating-a-docker-container-action.md @@ -96,7 +96,7 @@ runs: ``` {% endraw %} -This metadata defines one `who-to-greet` input and one `time` output parameter. To pass inputs to the Docker container, you should declare the input using `inputs` and pass the input in the `args` keyword. Everything you pass to the `args` will be passed to the container, but for readability purposes, it is best practice to use inputs. +This metadata defines one `who-to-greet` input and one `time` output parameter. To pass inputs to the Docker container, you should declare the input using `inputs` and pass the input in the `args` keyword. Everything you include in `args` is passed to the container, but for better discoverability for users of your action, we recommended using inputs. {% data variables.product.prodname_dotcom %} will build an image from your `Dockerfile`, and run commands in a new container using this image. From 39d746c27dc151fbdb10c4a5e58b7bb1aae5f51e Mon Sep 17 00:00:00 2001 From: Nikola Jokic <97525037+nikola-jokic@users.noreply.github.com> Date: Mon, 28 Mar 2022 09:19:54 +0200 Subject: [PATCH 7/7] Update content/actions/using-workflows/workflow-commands-for-github-actions.md Co-authored-by: Lucas Costi --- .../using-workflows/workflow-commands-for-github-actions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/actions/using-workflows/workflow-commands-for-github-actions.md b/content/actions/using-workflows/workflow-commands-for-github-actions.md index 3325c7388e..ec8355690a 100644 --- a/content/actions/using-workflows/workflow-commands-for-github-actions.md +++ b/content/actions/using-workflows/workflow-commands-for-github-actions.md @@ -309,7 +309,7 @@ jobs: ::add-mask::{value} ``` -Masking a value prevents a string or variable from being printed in the log. Each masked word separated by whitespace is replaced with the `*` character. You can use an environment variable or string for the mask's `value`. Masked outputs are considered as secrets, and will be redacted on the runner. See [Workflow commands for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions). +Masking a value prevents a string or variable from being printed in the log. Each masked word separated by whitespace is replaced with the `*` character. You can use an environment variable or string for the mask's `value`. When you mask a value, it is treated as a secret and will be redacted on the runner. For example, after you mask a value, you won't be able to set that value as an output. ### Example: Masking a string