From 9a89d1e63f689d45a47fecedd78c78f81aa838c3 Mon Sep 17 00:00:00 2001 From: Yan Yi Goh <yanyi@users.noreply.github.com> Date: Sun, 12 Apr 2020 11:43:21 +0800 Subject: [PATCH] Docs: Fix spelling mistakes (#50) * README: Fix spelling mistakes * README: Rename OSX to macOS * CONTRIBUTING: Fix spelling mistakes --- CONTRIBUTING.md | 9 ++++----- README.md | 8 ++++---- 2 files changed, 8 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 839b466..1ce34ae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,12 @@ ## bootstrapping -This a [JavaScript](https://help.github.com/en/articles/about-actions#types-of-actions) action but uses [TypeScript](https://www.typescriptlang.org/docs/home.html) to generate that JavaScript. +This a [JavaScript](https://help.github.com/en/articles/about-actions#types-of-actions) action but uses [TypeScript](https://www.typescriptlang.org/docs/home.html) to generate that JavaScript. -You can bootstrap your envrinment with a modern version of npm and by running `npm i` at the root of this repo. +You can bootstrap your environment with a modern version of npm and by running `npm i` at the root of this repo. ## testing -Tests can be found under under `__tests__` directory and are runnable with the `npm t` command +Tests can be found under under `__tests__` directory and are runnable with the `npm t` command. ## source code @@ -14,5 +14,4 @@ Source code can be found under the `src` directory. Running `npm run build` will ## formatting -A minimal attempt at keeping a consistent code style is can be applied by running `npm run fmt` - +A minimal attempt at keeping a consistent code style is can be applied by running `npm run fmt`. diff --git a/README.md b/README.md index e0f4488..1394e53 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ </h1> <p align="center"> - A GitHub Action for creating GitHub Releases on Linux, Windows, and OSX virtual environments + A GitHub Action for creating GitHub Releases on Linux, Windows, and macOS virtual environments </p> <div align="center"> @@ -29,7 +29,7 @@ Typically usage of this action involves adding a step to a build that is gated pushes to git tags. You may find `step.if` field helpful in accomplishing this -as it maximizes the resuse value of your workflow for non-tag pushes. +as it maximizes the reuse value of your workflow for non-tag pushes. Below is a simple example of `step.if` tag gating @@ -75,7 +75,7 @@ jobs: ### ⬆️ Uploading release assets -You can can configure a number of options for your +You can configure a number of options for your GitHub release and all are optional. A common case for GitHub releases is to upload your binary after its been validated and packaged. @@ -202,6 +202,6 @@ The following are *required* as `step.env` keys | `GITHUB_TOKEN` | GITHUB_TOKEN as provided by `secrets`| -> **⚠️ 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 +> **⚠️ 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 Doug Tangren (softprops) 2019