softprops/action-gh-release
0
0
Fork 0
Code Issues Pull Requests Projects Releases Activity

use spaces instead tab (#87)

Browse Source
This commit is contained in:
takmr 2021-03-23 02:05:06 +09:00 committed by softprops
parent 05d11c9fe8
commit 36fae76a5c
1 changed files with 21 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@ -1,4 +1,3 @@
<div align="center"> <div align="center">
📦 :octocat: 📦 :octocat:
</div> </div>
@ -20,7 +19,6 @@
</a> </a>
</div> </div>
<br /> <br />
## 🤸 Usage ## 🤸 Usage
@ -57,7 +55,7 @@ name: Main
on: on:
push: push:
tags: tags:
- 'v*.*.*' - "v*.*.*"
jobs: jobs:
build: build:
@ -164,17 +162,17 @@ jobs:
The following are optional as `step.with` keys The following are optional as `step.with` keys
| Name | Type | Description | | Name | Type | Description |
|---------------------------|---------|-----------------------------------------------------------------------| | ------------------------- | ------- | ---------------------------------------------------------------------- |
| `body` | String | Text communicating notable changes in this release | | `body` | String | Text communicating notable changes in this release |
| `body_path` | String | Path to load text communicating notable changes in this release | | `body_path` | String | Path to load text communicating notable changes in this release |
| `draft` | Boolean | Indicator of whether or not this release is a draft | | `draft` | Boolean | Indicator of whether or not this release is a draft |
| `prerelease` | Boolean | Indicator of whether or not is a prerelease | | `prerelease` | Boolean | Indicator of whether or not is a prerelease |
| `files` | String | Newline-delimited globs of paths to assets to upload for release | | `files` | String | Newline-delimited globs of paths to assets to upload for release |
| `name` | String | Name of the release. defaults to tag name | | `name` | String | Name of the release. defaults to tag name |
| `tag_name` | String | Name of a tag. defaults to `github.ref` | | `tag_name` | String | Name of a tag. defaults to `github.ref` |
| `fail_on_unmatched_files` | Boolean | Indicator of whether to fail if any of the `files` globs match nothing| | `fail_on_unmatched_files` | Boolean | Indicator of whether to fail if any of the `files` globs match nothing |
| `token` | String | Secret GitHub Personal Access Token. Defaults to `${{ github.token }}`| | `token` | String | Secret GitHub Personal Access Token. Defaults to `${{ github.token }}` |
💡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 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.
@ -182,21 +180,20 @@ The following are optional as `step.with` keys
The following outputs can be accessed via `${{ steps.<step-id>.outputs }}` from this action The following outputs can be accessed via `${{ steps.<step-id>.outputs }}` from this action
| Name | Type | Description | | Name | Type | Description |
|-------------|---------|-----------------------------------------------------------------| | ------------ | ------ | --------------------------------------- |
| `url` | String | Github.com URL for the release | | `url` | String | Github.com URL for the release |
| `upload_url`| String | URL for uploading assets to the release | | `id` | String | Release ID |
| `upload_url` | String | URL for uploading assets to the release |
#### environment variables #### environment variables
The following `step.env` keys are allowed as a fallback but deprecated in favor of using inputs. The following `step.env` keys are allowed as a fallback but deprecated in favor of using inputs.
| Name | Description | | Name | Description |
|----------------|------------------------------------------------------------------------------------------------| | ------------------- | ------------------------------------------------------------------------------------------ |
| `GITHUB_TOKEN` | GITHUB_TOKEN as provided by `secrets` | | `GITHUB_TOKEN` | GITHUB_TOKEN as provided by `secrets` |
| `GITHUB_REPOSITORY` | Name of a target repository in `<owner>/<repo>` format. defaults to the current repository| | `GITHUB_REPOSITORY` | Name of a target repository in `<owner>/<repo>` 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 > **⚠️ 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