Allow kebab-case input option names

taiki-e · Oct 9, 2023 · 46479c8 · 46479c8
1 parent cedd1a2
commit 46479c8
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 31 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -62,11 +62,11 @@ jobs:
       - run: cargo new --bin test-crate
       - uses: ./
         with:
-          dry_run: true
+          dry-run: true
           bin: test-crate
           target: ${{ matrix.target }}
-          build_tool: ${{ matrix.build_tool }}
+          build-tool: ${{ matrix.build_tool }}
           checksum: sha256,sha512,sha1,md5
           tar: all
           zip: all
-          manifest_path: test-crate/Cargo.toml
+          manifest-path: test-crate/Cargo.toml
diff --git a/README.md b/README.md
@@ -35,24 +35,26 @@ Currently, this action is basically intended to be used in combination with an a
 | 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  |                |
+| 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        | 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`        |
+| no-default-features | false        | Whether to disable cargo build default features                                              | 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 (sha256, sha512, sha1, or md5)    | 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`        |
-| build_tool          | false        | Tool to build binaries (cargo, cross, or cargo-zigbuild, see [cross-compilation example](#example-workflow-cross-compilation) for more) | String |                |
+| leading-dir         | false        | Whether to create the leading directory in the archive or not                                | Boolean | `false`        |
+| 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`   |
+| 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`        |
+| dry-run             | false        | Build and compress binaries, but do not upload them (see [action.yml](action.yml) for more)  | Boolean | `false`        |
 
-[^1]: Required one of `token` input option or `GITHUB_TOKEN` environment variable.
+\[1] Required one of `token` input option or `GITHUB_TOKEN` environment variable. Not required when `dry-run` input option is set to `true`.
+
+(Previously, option names were only in "snake_case", but now both "kebab-case" and "snake_case" are available.)
 
 ### Example workflow: Basic usage
 
@@ -404,7 +406,7 @@ jobs:
 
 #### cargo-zigbuild
 
-if you want to use [cargo-zigbuild], if the heuristic to detect host cross-compilation setups does not work well, or if you want to force the use of cargo or cross, you can use the `build_tool` input option.
+if you want to use [cargo-zigbuild], if the heuristic to detect host cross-compilation setups does not work well, or if you want to force the use of cargo or cross, you can use the `build-tool` input option.
 
 If cargo-zigbuild is not installed, this action calls `pip3 install cargo-zigbuild` to install cargo-zigbuild.
 
@@ -434,14 +436,14 @@ jobs:
         include:
           - target: x86_64-unknown-linux-gnu
             os: ubuntu-latest
-            build_tool: cargo-zigbuild
+            build-tool: cargo-zigbuild
           # cargo-zigbuild's glibc version suffix is also supported.
           - target: aarch64-unknown-linux-gnu.2.17
             os: ubuntu-latest
-            build_tool: cargo-zigbuild
+            build-tool: cargo-zigbuild
           - target: aarch64-apple-darwin
             os: macos-latest
-            build_tool: cargo
+            build-tool: cargo
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4
@@ -452,7 +454,7 @@ jobs:
           # (optional) Target triple, default is host triple.
           target: ${{ matrix.target }}
           # (optional) Tool to build binaries (cargo, cross, or cargo-zigbuild)
-          build_tool: ${{ matrix.build_tool }}
+          build-tool: ${{ matrix.build-tool }}
           # (required) GitHub token for uploading assets to GitHub Releases.
           token: ${{ secrets.GITHUB_TOKEN }}
 ```
@@ -508,7 +510,7 @@ By default, the expanded archive does not include the leading directory. In the
 /README.md
 ```
 
-You can use the `leading_dir` option to create the leading directory.
+You can use the `leading-dir` option to create the leading directory.
 
 ```yaml
 - uses: taiki-e/upload-rust-binary-action@v1
@@ -520,7 +522,7 @@ You can use the `leading_dir` option to create the leading directory.
     # Note that glob pattern is not supported yet.
     include: LICENSE,README.md
     # (optional) Whether to create the leading directory in the archive or not. default to false.
-    leading_dir: true
+    leading-dir: true
     # (required) GitHub token for uploading assets to GitHub Releases.
     token: ${{ secrets.GITHUB_TOKEN }}
 ```

diff --git a/action.yml b/action.yml
@@ -17,13 +17,19 @@ inputs:
   features:
     description: Comma-separated list of cargo build features to enable
     required: false
-  no_default_features:
+  no-default-features:
     description: Whether to disable cargo build default features
     required: false
+  no_default_features:
+    description: Alias for 'no-default-features'
+    required: false
     default: 'false'
-  manifest_path:
+  manifest-path:
     description: Override cargo manifest path
     required: false
+  manifest_path:
+    description: Alias for 'manifest-path'
+    required: false
   tar:
     description: On which platform to distribute the `.tar.gz` file (all, unix, windows, or none)
     required: false
@@ -42,13 +48,19 @@ inputs:
       Comma-separated list of additional files to be uploaded separately.
       Note that glob pattern is not supported yet.
     required: false
-  leading_dir:
+  leading-dir:
     description: Whether to create the leading directory in the archive or not
     required: false
+  leading_dir:
+    description: Alias for 'leading-dir'
+    required: false
     default: 'false'
-  build_tool:
+  build-tool:
     description: Tool to build binaries (cargo, cross, or cargo-zigbuild)
     required: false
+  build_tool:
+    description: Alias for 'build-tool'
+    required: false
   checksum:
     description: Comma-separated list of algorithms to be used for checksum (sha256, sha512, sha1, or md5)
     required: false
@@ -68,15 +80,17 @@ inputs:
     description: The cargo profile to build. This defaults to the release profile.
     required: false
     default: 'release'
-  dry_run:
+  dry-run:
     description: >
       Build and compress binaries, but do not upload them.
 
       Note that some errors are downgraded to warnings in this mode.
     required: false
+  dry_run:
+    description: Alias for 'dry-run'
+    required: false
     default: 'false'
 
-# TODO: allow kebab-case input option names?
 # Note:
 # - inputs.* should be manually mapped to INPUT_* due to https://github.com/actions/runner/issues/665
 # - Use GITHUB_*/RUNNER_* instead of github.*/runner.* due to https://github.com/actions/runner/issues/2185
@@ -90,16 +104,16 @@ runs:
         INPUT_ARCHIVE: ${{ inputs.archive }}
         INPUT_TARGET: ${{ inputs.target }}
         INPUT_FEATURES: ${{ inputs.features }}
-        INPUT_NO_DEFAULT_FEATURES: ${{ inputs.no_default_features }}
-        INPUT_MANIFEST_PATH: ${{ inputs.manifest_path }}
+        INPUT_NO_DEFAULT_FEATURES: ${{ inputs.no-default-features || inputs.no_default_features }}
+        INPUT_MANIFEST_PATH: ${{ inputs.manifest-path || inputs.manifest_path }}
         INPUT_TAR: ${{ inputs.tar }}
         INPUT_ZIP: ${{ inputs.zip }}
         INPUT_INCLUDE: ${{ inputs.include }}
         INPUT_ASSET: ${{ inputs.asset }}
-        INPUT_LEADING_DIR: ${{ inputs.leading_dir }}
-        INPUT_BUILD_TOOL: ${{ inputs.build_tool }}
+        INPUT_LEADING_DIR: ${{ inputs.leading-dir || inputs.leading_dir }}
+        INPUT_BUILD_TOOL: ${{ inputs.build-tool || inputs.build_tool }}
         INPUT_CHECKSUM: ${{ inputs.checksum }}
         INPUT_TOKEN: ${{ inputs.token }}
         INPUT_REF: ${{ inputs.ref }}
         INPUT_PROFILE: ${{ inputs.profile }}
-        INPUT_DRY_RUN: ${{ inputs.dry_run }}
+        INPUT_DRY_RUN: ${{ inputs.dry-run || inputs.dry_run }}
diff --git a/main.sh b/main.sh
@@ -43,7 +43,7 @@ dry_run="${INPUT_DRY_RUN:-}"
 case "${dry_run}" in
     true) dry_run="1" ;;
     false) dry_run="" ;;
-    *) bail "'dry_run' input option must be 'true' or 'false': '${dry_run}'" ;;
+    *) bail "'dry-run' input option must be 'true' or 'false': '${dry_run}'" ;;
 esac
 
 token="${INPUT_TOKEN:-"${GITHUB_TOKEN:-}"}"
@@ -84,14 +84,14 @@ leading_dir="${INPUT_LEADING_DIR:-}"
 case "${leading_dir}" in
     true) leading_dir="1" ;;
     false) leading_dir="" ;;
-    *) bail "'leading_dir' input option must be 'true' or 'false': '${leading_dir}'" ;;
+    *) bail "'leading-dir' input option must be 'true' or 'false': '${leading_dir}'" ;;
 esac
 
 no_default_features="${INPUT_NO_DEFAULT_FEATURES:-}"
 case "${no_default_features}" in
     true) no_default_features="1" ;;
     false) no_default_features="" ;;
-    *) bail "'no_default_features' input option must be 'true' or 'false': '${no_default_features}'" ;;
+    *) bail "'no-default-features' input option must be 'true' or 'false': '${no_default_features}'" ;;
 esac
 
 bin_name="${INPUT_BIN:?}"