Skip to content

Commit c29b52c

Browse files
taiki-etaiki-e
committed
Update readme
1 parent 2c9051d commit c29b52c

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

‎README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -33,30 +33,30 @@ Currently, this action is basically intended to be used in combination with an a
3333

3434
### Inputs
3535

36-
| Name | Required | Description | Type | Default |
37-
| ------------------- |:------------:| -------------------------------------------------------------------------------------------- | ------- | -------------- |
38-
| bin | **true** | Comma-separated list of binary names (non-extension portion of filename) to build and upload | String | |
39-
| token | **true** \[1]| GitHub token for creating GitHub Releases (see [action.yml](action.yml) for more) | String | |
40-
| archive | false | Archive name (non-extension portion of filename) to be uploaded | String | `$bin-$target` |
41-
| target | false \[2] | Target triple, default is host triple | String | (host triple) |
42-
| features | false | Comma-separated list of cargo build features to enable | String | |
43-
| no-default-features | false | Whether to disable cargo build default features | Boolean | `false` |
44-
| locked | false | Whether to build with `--locked` flag | Boolean | `false` |
45-
| tar | false | On which platform to distribute the `.tar.gz` file (all, unix, windows, or none) | String | `unix` |
46-
| zip | false | On which platform to distribute the `.zip` file (all, unix, windows, or none) | String | `windows` |
47-
| 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 | |
48-
| include | false | Comma-separated list of additional files to be included to the archive | String | |
49-
| asset | false | Comma-separated list of additional files to be uploaded separately | String | |
50-
| leading-dir | false | Whether to create the leading directory in the archive or not | Boolean | `false` |
51-
| bin-leading-dir | false | Create extra leading directory(s) for binary file(s) specified by `bin` option | String | |
52-
| build-tool | false | Tool to build binaries (cargo, cross, or cargo-zigbuild, see [cross-compilation example](#example-workflow-cross-compilation) for more) | String | |
53-
| ref | false | Fully-formed tag ref for this release (see [action.yml](action.yml) for more) | String | |
54-
| manifest-path | false | Path to Cargo.toml | String | `Cargo.toml` |
55-
| profile | false | The cargo profile to build. This defaults to the release profile. | String | `release` |
56-
| dry-run | false | Build and compress binaries, but do not upload them (see [action.yml](action.yml) for more) | Boolean | `false` |
57-
| codesign | false | Sign build products using `codesign` on macOS | String | |
58-
| codesign-prefix | false | Prefix for the `codesign` identifier on macOS | String | |
59-
| 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 | |
36+
| Name | Required | Description | Type | Default |
37+
| ------------------- |:---------:| -------------------------------------------------------------------------------------------- | ------- | -------------- |
38+
| bin | **✓** | Comma-separated list of binary names (non-extension portion of filename) to build and upload | String | |
39+
| token | **✓** \[1]| GitHub token for creating GitHub Releases (see [action.yml](action.yml) for more) | String | |
40+
| archive | | Archive name (non-extension portion of filename) to be uploaded | String | `$bin-$target` |
41+
| target | \[2] | Target triple, default is host triple | String | (host triple) |
42+
| features | | Comma-separated list of cargo build features to enable | String | |
43+
| no-default-features | | Whether to disable cargo build default features | Boolean | `false` |
44+
| locked | | Whether to build with `--locked` flag | Boolean | `false` |
45+
| tar | | On which platform to distribute the `.tar.gz` file (all, unix, windows, or none) | String | `unix` |
46+
| zip | | On which platform to distribute the `.zip` file (all, unix, windows, or none) | String | `windows` |
47+
| 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 | |
48+
| include | | Comma-separated list of additional files to be included to the archive | String | |
49+
| asset | | Comma-separated list of additional files to be uploaded separately | String | |
50+
| leading-dir | | Whether to create the leading directory in the archive or not | Boolean | `false` |
51+
| bin-leading-dir | | Create extra leading directory(s) for binary file(s) specified by `bin` option | String | |
52+
| build-tool | | Tool to build binaries (cargo, cross, or cargo-zigbuild, see [cross-compilation example](#example-workflow-cross-compilation) for more) | String | |
53+
| ref | | Fully-formed tag ref for this release (see [action.yml](action.yml) for more) | String | |
54+
| manifest-path | | Path to Cargo.toml | String | `Cargo.toml` |
55+
| profile | | The cargo profile to build. This defaults to the release profile. | String | `release` |
56+
| dry-run | | Build and compress binaries, but do not upload them (see [action.yml](action.yml) for more) | Boolean | `false` |
57+
| codesign | | Sign build products using `codesign` on macOS | String | |
58+
| codesign-prefix | | Prefix for the `codesign` identifier on macOS | String | |
59+
| codesign-options | | Specifies a set of option flags to be embedded in the code signature on macOS. See the `codesign` manpage for details. | String | |
6060

6161
\[1] Required one of `token` input option or `GITHUB_TOKEN` environment variable. Not required when `dry-run` input option is set to `true`.<br>
6262
\[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>

0 commit comments

Comments
 (0)