From a609ba51bf0f1a8fe5db21daeaef1416d0d0c69f Mon Sep 17 00:00:00 2001 From: Mieszko Grodzicki Date: Wed, 1 Mar 2023 00:43:41 +0100 Subject: [PATCH] Polish input descriptions --- README.md | 2 +- action.yml | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9b059bc..3f502ea 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Every argument is optional. | Input | Description | Default | |--------------------|-----------------------------------------------------------------------------------------------------------------------------------|---------| | `package` | The package whose API to check for semver (in Package Id Specification format, see https://doc.rust-lang.org/cargo/reference/pkgid-spec.html for reference). If not set, all packages defined in the Cargo.toml file are processed. | | -| `manifest-path` | Path to Cargo.toml of crate or workspace to check. By default, the action will assume it exists in the current directory. | | +| `manifest-path` | Path to Cargo.toml of crate or workspace to check. If not specified, the action assumes the manifest is under the default [`GITHUB_WORKSPACE`](https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables) path. | | | `verbose` | Enables verbose output of `cargo-semver-checks`. | `false` | | `github-token` | The `GITHUB_TOKEN` secret used to download precompiled binaries from GitHub API. If not specified, the [automatic GitHub token](https://docs.github.com/en/actions/security-guides/automatic-token-authentication) provided to the workflow will be used. The token may be alternatively passed in an environment variable `GITHUB_TOKEN`. | | diff --git a/action.yml b/action.yml index 47ba32c..6c7f42c 100644 --- a/action.yml +++ b/action.yml @@ -5,10 +5,10 @@ branding: color: 'green' inputs: package: - description: 'The package whose API to check for semver (in Package Id Specification format, see https://doc.rust-lang.org/cargo/reference/pkgid-spec.html for reference). If not set, all packages in the workspace are processed.' + description: 'The package whose API to check for semver (in Package Id Specification format, see https://doc.rust-lang.org/cargo/reference/pkgid-spec.html for reference). If not set, all packages defined in the Cargo.toml file are processed.' required: false manifest-path: - description: 'Path to Cargo.toml of crate or workspace to check. By default, the action will assume it exists in the current directory.' + description: 'Path to Cargo.toml of crate or workspace to check. If not specified, the action assumes the manifest is under the default `GITHUB_WORKSPACE` path.' required: false verbose: description: 'Enables verbose output of `cargo-semver-checks`.'