Skip to content

Commit

Permalink
Update descriptions in README.md and action.yml
Browse files Browse the repository at this point in the history
Co-authored-by: Jan Amann <jan@amann.me>
Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
  • Loading branch information
2 people authored and Kenji Miyake committed Feb 8, 2022
1 parent 81e4c84 commit c101b57
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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)"
Expand Down

0 comments on commit c101b57

Please sign in to comment.