From f228ac0cf6c3c57f5b2d20412fea9158730cafd5 Mon Sep 17 00:00:00 2001 From: vlad doster Date: Sun, 17 Jan 2021 07:45:14 -0600 Subject: [PATCH] (docs) update README.md - reduce verbiage - correct spelling - add space after markdown headers --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a3c10f3..22ac857 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,30 @@ # GitHub Action - Releases API + This GitHub Action (written in JavaScript) wraps the [GitHub Release API](https://developer.github.com/v3/repos/releases/), specifically the [Upload a Release Asset](https://developer.github.com/v3/repos/releases/#upload-a-release-asset) endpoint, to allow you to leverage GitHub Actions to upload release assets. GitHub Actions status ## Usage + ### Pre-requisites -Create a workflow `.yml` file in your repositories `.github/workflows` directory. An [example workflow](#example-workflow---upload-a-release-asset) is available below. For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file). You also will need to have a release to upload your asset to, which could be created programmatically by [`@actions/create-release`](https://www.github.com/actions/create-release) as show in the example workflow. + +Create a workflow `.yml` file in your repositories `.github/workflows` directory. An [example workflow](#example-workflow---upload-a-release-asset) is available below. For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file). You will also need to have a release to upload your asset, which could be created programmatically by [`@actions/create-release`](https://www.github.com/actions/create-release) as shown in the example workflow. ### Inputs + For more information on these inputs, see the [API Documentation](https://developer.github.com/v3/repos/releases/#input-2) -- `upload_url`: The URL for uploading assets to the release, which could come from another GitHub Action, for example the [`@actions/create-release`](https://www.github.com/actions/create-release) GitHub Action +- `upload_url`: The URL for uploading assets to the release, which could come from another GitHub Action, for example, the [`@actions/create-release`](https://www.github.com/actions/create-release) GitHub Action ### Outputs + For more information on these outputs, see the [API Documentation](https://developer.github.com/v3/repos/releases/#response-for-successful-upload) for an example of what these outputs look like - `id`: The ID of the asset -- `browser_download_url`: The URL users can navigate to in order to download the release asset. i.e. `https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip` +- `browser_download_url`: The URL users can navigate to download the release asset. i.e. `https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip` ### Example workflow - upload a release asset + On every `push` to a tag matching the pattern `v*`, [create a release](https://developer.github.com/v3/repos/releases/#create-a-release) and [upload a release asset](https://developer.github.com/v3/repos/releases/#upload-a-release-asset). This Workflow example assumes you have the [`@actions/create-release`](https://www.github.com/actions/create-release) Action in a previous step: ```yaml @@ -37,7 +43,7 @@ jobs: steps: - name: Checkout code uses: actions/checkout@v2 - - name: Build project # This would actually build your project, using zip for an example artifact + - name: Build project # This would build your project, using zip for an example artifact run: | zip --junk-paths my-artifact README.md - name: Create Release @@ -62,10 +68,12 @@ jobs: asset_content_type: application/zip ``` -This will upload a release artifact to an existing release, outputting the `browser_download_url` for the asset which could be handled by a third party service, or by GitHub Actions for additional uses. For more information, see the GitHub Documentation for the [upload a release asset](https://developer.github.com/v3/repos/releases/#upload-a-release-asset) endpoint. +This will upload a release artifact to an existing release, outputting the `browser_download_url` for the asset that a third party service or GitHub Actions could handle for different uses. See the GitHub documentation for the [upload a release asset](https://developer.github.com/v3/repos/releases/#upload-a-release-asset) endpoint. ## Contributing -We would love you to contribute to `@actions/upload-release-asset`, pull requests are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) for more information. + +We would love you to contribute to `@actions/upload-release-asset`; pull requests are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) for more information. ## License + The scripts and documentation in this project are released under the [MIT License](LICENSE)