Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@taiki-e
taiki-e committed Jan 16, 2025
1 parent 2c9051d commit c29b52c
Showing 1 changed file with 24 additions and 24 deletions.
48 changes: 24 additions & 24 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,30 +33,30 @@ Currently, this action is basically intended to be used in combination with an a

### Inputs

| Name | Required | Description | Type | Default |
| ------------------- |:------------:| -------------------------------------------------------------------------------------------- | ------- | -------------- |
| bin | **true** | Comma-separated list of binary names (non-extension portion of filename) to build and upload | String | |
| token | **true** \[1]| GitHub token for creating GitHub Releases (see [action.yml](action.yml) for more) | String | |
| archive | false | Archive name (non-extension portion of filename) to be uploaded | String | `$bin-$target` |
| target | false \[2] | Target triple, default is host triple | String | (host triple) |
| features | false | Comma-separated list of cargo build features to enable | String | |
| no-default-features | false | Whether to disable cargo build default features | Boolean | `false` |
| locked | false | Whether to build with `--locked` flag | Boolean | `false` |
| tar | false | On which platform to distribute the `.tar.gz` file (all, unix, windows, or none) | String | `unix` |
| zip | false | On which platform to distribute the `.zip` file (all, unix, windows, or none) | String | `windows` |
| checksum | false | Comma-separated list of algorithms to be used for checksum (b2, sha256, sha512, sha1, or md5).<br>Note: b2 is not available by default on macOS, install `b2sum` to use it. | String | |
| include | false | Comma-separated list of additional files to be included to the archive | String | |
| asset | false | Comma-separated list of additional files to be uploaded separately | String | |
| leading-dir | false | Whether to create the leading directory in the archive or not | Boolean | `false` |
| bin-leading-dir | false | Create extra leading directory(s) for binary file(s) specified by `bin` option | String | |
| build-tool | false | Tool to build binaries (cargo, cross, or cargo-zigbuild, see [cross-compilation example](#example-workflow-cross-compilation) for more) | String | |
| ref | false | Fully-formed tag ref for this release (see [action.yml](action.yml) for more) | String | |
| manifest-path | false | Path to Cargo.toml | String | `Cargo.toml` |
| profile | false | The cargo profile to build. This defaults to the release profile. | String | `release` |
| dry-run | false | Build and compress binaries, but do not upload them (see [action.yml](action.yml) for more) | Boolean | `false` |
| codesign | false | Sign build products using `codesign` on macOS | String | |
| codesign-prefix | false | Prefix for the `codesign` identifier on macOS | String | |
| codesign-options | false | Specifies a set of option flags to be embedded in the code signature on macOS. See the `codesign` manpage for details. | String | |
| Name | Required | Description | Type | Default |
| ------------------- |:---------:| -------------------------------------------------------------------------------------------- | ------- | -------------- |
| bin | **✓** | Comma-separated list of binary names (non-extension portion of filename) to build and upload | String | |
| token | **✓** \[1]| GitHub token for creating GitHub Releases (see [action.yml](action.yml) for more) | String | |
| archive | | Archive name (non-extension portion of filename) to be uploaded | String | `$bin-$target` |
| target | \[2] | Target triple, default is host triple | String | (host triple) |
| features | | Comma-separated list of cargo build features to enable | String | |
| no-default-features | | Whether to disable cargo build default features | Boolean | `false` |
| locked | | Whether to build with `--locked` flag | Boolean | `false` |
| tar | | On which platform to distribute the `.tar.gz` file (all, unix, windows, or none) | String | `unix` |
| zip | | On which platform to distribute the `.zip` file (all, unix, windows, or none) | String | `windows` |
| checksum | | Comma-separated list of algorithms to be used for checksum (b2, sha256, sha512, sha1, or md5).<br>Note: b2 is not available by default on macOS, install `b2sum` to use it. | String | |
| include | | Comma-separated list of additional files to be included to the archive | String | |
| asset | | Comma-separated list of additional files to be uploaded separately | String | |
| leading-dir | | Whether to create the leading directory in the archive or not | Boolean | `false` |
| bin-leading-dir | | Create extra leading directory(s) for binary file(s) specified by `bin` option | String | |
| build-tool | | Tool to build binaries (cargo, cross, or cargo-zigbuild, see [cross-compilation example](#example-workflow-cross-compilation) for more) | String | |
| ref | | Fully-formed tag ref for this release (see [action.yml](action.yml) for more) | String | |
| manifest-path | | Path to Cargo.toml | String | `Cargo.toml` |
| profile | | The cargo profile to build. This defaults to the release profile. | String | `release` |
| dry-run | | Build and compress binaries, but do not upload them (see [action.yml](action.yml) for more) | Boolean | `false` |
| codesign | | Sign build products using `codesign` on macOS | String | |
| codesign-prefix | | Prefix for the `codesign` identifier on macOS | String | |
| codesign-options | | Specifies a set of option flags to be embedded in the code signature on macOS. See the `codesign` manpage for details. | String | |

\[1] Required one of `token` input option or `GITHUB_TOKEN` environment variable. Not required when `dry-run` input option is set to `true`.<br>
\[2] This is optional but it is recommended that this always be set to clarify which target you are building for if macOS is included in the matrix because GitHub Actions changed the default architecture of macos-latest since macos-14.<br>
Expand Down

0 comments on commit c29b52c

Please sign in to comment.