wbrawner/action-gh-release
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Docs: Fix spelling mistakes (#50)

Browse source 
* README: Fix spelling mistakes

* README: Rename OSX to macOS

* CONTRIBUTING: Fix spelling mistakes
This commit is contained in:
Yan Yi Goh 2020-04-12 11:43:21 +08:00 committed by GitHub
parent 91409e712c
commit 9a89d1e63f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
CONTRIBUTING.md
View file

@ -1,12 +1,12 @@
## bootstrapping ## 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 ## 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
@ -14,5 +14,4 @@ Source code can be found under the `src` directory. Running `npm run build` will
## formatting ## 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
README.md
View file

@ -7,7 +7,7 @@
</h1> </h1>
<p align="center"> <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> </p>
<div align="center"> <div align="center">
@ -29,7 +29,7 @@
Typically usage of this action involves adding a step to a build that 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 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 Below is a simple example of `step.if` tag gating
@ -75,7 +75,7 @@ jobs:
### ⬆️ Uploading release assets ### ⬆️ 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. GitHub release and all are optional.
A common case for GitHub releases is to upload your binary after its been validated and packaged. 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`| | `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 Doug Tangren (softprops) 2019