Skip to content

Commit

Permalink
Docs: Fix spelling mistakes (#50)
Browse files Browse the repository at this point in the history
* README: Fix spelling mistakes

* README: Rename OSX to macOS

* CONTRIBUTING: Fix spelling mistakes
  • Loading branch information
yanyi committed Apr 12, 2020
1 parent 91409e7 commit 9a89d1e
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
9 changes: 4 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
## 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

Source code can be found under the `src` directory. Running `npm run build` will generate the JavaScript that will run within GitHub workflows.

## 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`.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand All @@ -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

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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

0 comments on commit 9a89d1e

Please sign in to comment.