From c101b573d402bd412b28b48532719bf970bfe6f5 Mon Sep 17 00:00:00 2001 From: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com> Date: Tue, 8 Feb 2022 16:31:09 +0900 Subject: [PATCH] Update descriptions in README.md and action.yml Co-authored-by: Jan Amann Signed-off-by: Kenji Miyake --- README.md | 6 ++---- action.yml | 2 +- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6f6ec177c..897171196 100644 --- a/README.md +++ b/README.md @@ -77,10 +77,8 @@ The action works without configuration, however you can provide options for cust # merge commit, and it's easy to commit this by mistake. Enable this option # to also validate the commit message for one commit PRs. validateSingleCommit: true - # When using "validateSingleCommit", even if you edit the PR title, the PR - # title is not used for the merge commit. Also, since it cannot detect an error - # as long as the commit message is semantic, it's easy to commit this by mistake. - # Enable this option to also validate if the PR title matches the commit title. + # Related to `validateSingleCommit` you can opt-in to validate that the PR + # title matches a single commit to avoid confusion. validateSingleCommitMatchesPrTitle: true # If you use Github Enterprise, you can set this to the URL of your server githubBaseUrl: https://github.myorg.com/api/v3 diff --git a/action.yml b/action.yml index 5cd6b8be9..0bacf5d70 100644 --- a/action.yml +++ b/action.yml @@ -30,7 +30,7 @@ inputs: description: "When using \"Squash and merge\" on a PR with only one commit, GitHub will suggest using that commit message instead of the PR title for the merge commit, and it's easy to commit this by mistake. Enable this option to also validate the commit message for one commit PRs." required: false validateSingleCommitMatchesPrTitle: - description: "When using \"validateSingleCommit\", even if you edit the PR title, the PR title is not used for the merge commit. Also, since it cannot detect an error as long as the commit message is semantic, it's easy to commit this by mistake. Enable this option to also validate if the PR title matches the commit title." + description: "Related to `validateSingleCommit` you can opt-in to validate that the PR title matches a single commit to avoid confusion." required: false githubBaseUrl: description: "If you use Github Enterprise, you can set this to the URL of your server (e.g. https://github.myorg.com/api/v3)"