Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
taiki-e committed Jun 2, 2024
1 parent 3ade1d6 commit 734b26e
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ GitHub Action for building and uploading Rust binary to GitHub Releases.

- [Usage](#usage)
- [Inputs](#inputs)
- [Outputs](#outputs)
- [Example workflow: Basic usage](#example-workflow-basic-usage)
- [Example workflow: Basic usage (multiple platforms)](#example-workflow-basic-usage-multiple-platforms)
- [Example workflow: Customize archive name](#example-workflow-customize-archive-name)
Expand Down Expand Up @@ -59,6 +60,18 @@ Currently, this action is basically intended to be used in combination with an a

(Previously, option names were only in "snake_case", but now both "kebab-case" and "snake_case" are available.)

### Outputs

| Name | Description |
|---------|------------------------------|
| archive | Archive base name. |
| zip | `.zip` archive file name. |
| tar | `.tar.gz` archive file name. |
| sha256 | SHA256 checksum file name. |
| sha512 | SHA512 checksum file name. |
| sha1 | SHA1 checksum file name. |
| md5 | MD5 checksum file name. |

### Example workflow: Basic usage

In this example, when a new tag is pushed, creating a new GitHub Release by
Expand Down
4 changes: 2 additions & 2 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -102,10 +102,10 @@ outputs:
description: 'Archive base name'
value: ${{ steps.upload-rust-binary-action.outputs.archive }}
zip:
description: 'ZIP archive file name'
description: '.zip archive file name'
value: ${{ steps.upload-rust-binary-action.outputs.zip }}
tar:
description: 'Tar archive file name'
description: '.tar.gz archive file name'
value: ${{ steps.upload-rust-binary-action.outputs.tar }}
sha256:
description: 'SHA256 checksum file name'
Expand Down

0 comments on commit 734b26e

Please sign in to comment.