From 3f406b717c61b27edf8c4b5e18a56e4a1311ca7b Mon Sep 17 00:00:00 2001 From: Oleksii Holub <1935960+Tyrrrz@users.noreply.github.com> Date: Fri, 13 Jan 2023 22:25:27 +0200 Subject: [PATCH] Use GitHub warning and note callouts in the readme --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index cd97f9c..89516d9 100644 --- a/README.md +++ b/README.md @@ -126,7 +126,8 @@ jobs: LICENSE ``` -> **⚠️ Note:** Notice the `|` in the yaml syntax above ☝️. That let's you effectively declare a multi-line yaml string. You can learn more about multi-line yaml syntax [here](https://yaml-multiline.info) +> **Warning**: +> Notice the `|` in the yaml syntax above ☝️. That let's you effectively declare a multi-line yaml string. You can learn more about multi-line yaml syntax [here](https://yaml-multiline.info) ### 📝 External release notes @@ -182,12 +183,11 @@ The following are optional as `step.with` keys | `generate_release_notes` | Boolean | Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes. See the [GitHub docs for this feature](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes) for more information | | `append_body` | Boolean | Append to existing body instead of overwriting it | -💡 When providing a `body` and `body_path` at the same time, `body_path` will be -attempted first, then falling back on `body` if the path can not be read from. +> **Info**: +> When providing a `body` and `body_path` at the same time, `body_path` will be attempted first, then falling back on `body` if the path can not be read from. -💡 When the release info keys (such as `name`, `body`, `draft`, `prerelease`, etc.) -are not explicitly set and there is already an existing release for the tag, the -release will retain its original info. +> **Info**: +> When the release info keys (such as `name`, `body`, `draft`, `prerelease`, etc.) are not explicitly set and there is already an existing release for the tag, the release will retain its original info. #### outputs @@ -211,7 +211,8 @@ The following `step.env` keys are allowed as a fallback but deprecated in favor | `GITHUB_TOKEN` | GITHUB_TOKEN as provided by `secrets` | | `GITHUB_REPOSITORY` | Name of a target repository in `/` format. defaults to the current repository | -> **⚠️ Note:** This action was previously implemented as a Docker container, limiting its use to GitHub Actions Linux virtual environments only. With recent releases, we now support cross platform usage. You'll need to remove the `docker://` prefix in these versions +> **Warning**: +> This action was previously implemented as a Docker container, limiting its use to GitHub Actions Linux virtual environments only. With recent releases, we now support cross platform usage. You'll need to remove the `docker://` prefix in these versions ### Permissions