Skip to content

Commit

Permalink
chore(release): fix breaking change marker (#14)
Browse files Browse the repository at this point in the history
  • Loading branch information
adjkant authored Apr 26, 2024
1 parent 2218ca1 commit cbb6aa2
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Please title your PR according to the following types and scopes following [conv
- `chore(<type>):` will not trigger any release and should be used for internal repo changes
- `<type>(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

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
- `<type>(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.
4 changes: 2 additions & 2 deletions publishing/release-rules.cjs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module.exports = [
{ type: "feat", scope: "!", release: "major" },
{ type: "feat", scope: "breaking", release: "major" },
{ scope: "public", release: "patch" },
];
];

0 comments on commit cbb6aa2

Please sign in to comment.