diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 881b8fe65..10e54a3e9 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,7 +6,7 @@ Please title your PR according to the following types and scopes following [conv - `chore():` will not trigger any release and should be used for internal repo changes - `(public):` will trigger a patch version for non-code changes (e.g. README changes) - `feat(SDK name):` will trigger a minor version -- `feat(!):` will trigger a major version for a breaking change +- `feat(breaking):` will trigger a major version for a breaking change ## Description @@ -20,7 +20,7 @@ _[e.g. Manually, E2E tests, unit tests, Storybook]_ _[e.g. Type definitions, API definitions]_ -If there are breaking changes, please ensure you bump the major version Bump the major version (by using the title `feat(!): ...`), post a notice in #eng-sdks, and explicitly notify all Uniswap Labs consumers of the SDK. +If there are breaking changes, please ensure you bump the major version Bump the major version (by using the title `feat(breaking): ...`), post a notice in #eng-sdks, and explicitly notify all Uniswap Labs consumers of the SDK. ## (Optional) Feedback Focus diff --git a/README.md b/README.md index 53560618b..5af2566f6 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Publishing of each SDK is done on merge to main using semantic-release and seman - `fix(SDK name):` will trigger a patch version - `(public):` will trigger a patch version - `feat(SDK name):` will trigger a minor version -- `feat(!):` will trigger a major version for a breaking change +- `feat(breaking):` will trigger a major version for a breaking change ``` Versions will only be generated based on the changelog of the relevant SDK's folder/files. diff --git a/publishing/release-rules.cjs b/publishing/release-rules.cjs index ab6be5b49..213045043 100644 --- a/publishing/release-rules.cjs +++ b/publishing/release-rules.cjs @@ -1,4 +1,4 @@ module.exports = [ - { type: "feat", scope: "!", release: "major" }, + { type: "feat", scope: "breaking", release: "major" }, { scope: "public", release: "patch" }, -]; \ No newline at end of file +];