diff --git a/README.rst b/README.rst index 4792d73cf..4d81c7c83 100644 --- a/README.rst +++ b/README.rst @@ -222,5 +222,4 @@ URL of your target FlyteAdmin API instance. These instructions will use ======= Release ======= -To release, you have to annotate the PR message to include either #minor, -#patch or #major. +To release, you have to annotate the PR message to include one of the following `commit-analyzer types `_. diff --git a/pull_request_template.md b/pull_request_template.md index 9cdab99b4..08db4d830 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -2,8 +2,9 @@ _- Make sure to use a concise title for the pull-request._ -_- Use #patch, #minor or #major in the pull-request title to bump the corresponding version. Otherwise, the patch version -will be bumped. [More details](https://github.com/marketplace/actions/github-tag-bump)_ +_- if you want to create a new release, make sure to modify your commit message to include one +of [commit-analyzer types](https://github.com/semantic-release/commit-analyzer#rules-matching). +More information in [semantic-release.gitbook.io](https://semantic-release.gitbook.io/semantic-release/#commit-message-format)._ # TL;DR _Please replace this text with a description of what this PR accomplishes._