Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release/182.0.0 #4600

Merged
merged 2 commits into from
Aug 12, 2024
Merged

Release/182.0.0 #4600

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b050edd
Release/182.0.0
Prithpal-Sooriya Aug 12, 2024
e5dca9f
Merge branch 'main' into release/182.0.0
Prithpal-Sooriya Aug 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@metamask/core-monorepo",
"version": "181.0.0",
"version": "182.0.0",
"private": true,
"description": "Monorepo for packages shared between MetaMask clients",
"repository": {
Expand Down
15 changes: 14 additions & 1 deletion packages/notification-services-controller/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.2.1]

### Added

- new controller events when notifications list is updated or notifications are read ([#4573](https://github.com/MetaMask/core/pull/4573))
- unlock checks for when controller methods are called ([#4569](https://github.com/MetaMask/core/pull/4569))

### Changed

- updated controller event type names ([#4592](https://github.com/MetaMask/core/pull/4592))
- Bump `typescript` from `~5.0.4` to `~5.1.6` ([#4576](https://github.com/MetaMask/core/pull/4576))

## [0.2.0]

### Added
Expand Down Expand Up @@ -56,7 +68,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- Initial release

[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/[email protected]
[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/[email protected]
[0.2.1]: https://github.com/MetaMask/core/compare/@metamask/[email protected]...@metamask/[email protected]
[0.2.0]: https://github.com/MetaMask/core/compare/@metamask/[email protected]...@metamask/[email protected]
[0.1.2]: https://github.com/MetaMask/core/compare/@metamask/[email protected]...@metamask/[email protected]
[0.1.1]: https://github.com/MetaMask/core/compare/@metamask/[email protected]...@metamask/[email protected]
Expand Down
6 changes: 3 additions & 3 deletions packages/notification-services-controller/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@metamask/notification-services-controller",
"version": "0.2.0",
"version": "0.2.1",
"description": "Manages New MetaMask decentralized Notification system",
"keywords": [
"MetaMask",
Expand Down Expand Up @@ -54,7 +54,7 @@
"@lavamoat/allow-scripts": "^3.0.4",
"@metamask/auto-changelog": "^3.4.4",
"@metamask/keyring-controller": "^17.1.2",
"@metamask/profile-sync-controller": "^0.2.0",
"@metamask/profile-sync-controller": "^0.2.1",
"@types/jest": "^27.4.1",
"@types/readable-stream": "^2.3.0",
"deepmerge": "^4.2.2",
Expand All @@ -68,7 +68,7 @@
},
"peerDependencies": {
"@metamask/keyring-controller": "^17.0.0",
"@metamask/profile-sync-controller": "^0.2.0"
"@metamask/profile-sync-controller": "^0.2.1"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a breaking change. This should have resulted in a minor version bump (since this package is pre-v1), but it looks like it wasn't even referenced in the changelog

Copy link
Contributor Author

@Prithpal-Sooriya Prithpal-Sooriya Aug 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True, this should've been a minor instead of a patch.

How critical is this to revert?
Our only client consuming this is mobile.

I can update the changelog in a following PR.

Copy link
Contributor

@MajorLift MajorLift Aug 13, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this diff necessary in the first place? "^0.2.0" should be compatible with "0.2.1" so there is no need to update to "^0.2.1" unless we're specifically trying to prevent "0.2.0" from being used.

If avoiding "0.2.0" is the intention, having a Fixed entry in the changelog to explain why would be helpful. Also, since updating a peerDep is a breaking change, it's probably high-priority enough to need to be communicated in the v182.0.0 release notes, not just the @metamask/[email protected] changelog. This will only be possible through a revert, not a changelog backport.

On a more general note, we should probably be using the tilde (~) operator e.g. "~0.2.0" instead of the carat (^) for versioning pre-v1 packages, since we don't want "minor" releases to be compatible with each other.

Copy link
Contributor

@legobeat legobeat Aug 13, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the carat operator, "^0.x.y" will all resolve as the same version, which makes it meaningless and contrary to our intentions here. With tilde, "~0.2.0" and "~0.2.1" will both resolve to "0.2.0", while "~0.3.1" will resolve to "0.3.0".

^ actually works differently with 0.x.y ranges: ^0.3 will not be satisfied by 0.4.0, for example.

https://github.com/npm/node-semver?tab=readme-ov-file#caret-ranges-123-025-004

Allows changes that do not modify the left-most non-zero element in the [major, minor, patch] tuple. In other words, this allows patch and minor updates for versions 1.0.0 and above, patch updates for versions 0.X >=0.1.0, and no updates for versions 0.0.X.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yes I deleted that part because I realized it contradicts the entire point of my comment😂 (e.g. ^0.3.1 and ~0.3.1 both shouldn't resolve to 0.3.0).

But I wasn't aware of the subtlety around leading zeros and missing patch or minor values. Guess the carat should work here as is. TIL!

},
"engines": {
"node": "^18.18 || >=20"
Expand Down
14 changes: 13 additions & 1 deletion packages/profile-sync-controller/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.2.1]

### Added

- unlock checks for when controller methods are called ([#4569](https://github.com/MetaMask/core/pull/4569))

### Changed

- **BREAKING** made `MOCK_ENCRYPTED_STORAGE_DATA` fixture a function to be lazily evaluated ([#4592](https://github.com/MetaMask/core/pull/4592))
- Bump `typescript` from `~5.0.4` to `~5.1.6` ([#4576](https://github.com/MetaMask/core/pull/4576))

## [0.2.0]

### Added
Expand Down Expand Up @@ -84,7 +95,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- Initial release

[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/[email protected]
[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/[email protected]
[0.2.1]: https://github.com/MetaMask/core/compare/@metamask/[email protected]...@metamask/[email protected]
[0.2.0]: https://github.com/MetaMask/core/compare/@metamask/[email protected]...@metamask/[email protected]
[0.1.4]: https://github.com/MetaMask/core/compare/@metamask/[email protected]...@metamask/[email protected]
[0.1.3]: https://github.com/MetaMask/core/compare/@metamask/[email protected]...@metamask/[email protected]
Expand Down
2 changes: 1 addition & 1 deletion packages/profile-sync-controller/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@metamask/profile-sync-controller",
"version": "0.2.0",
"version": "0.2.1",
"description": "The profile sync helps developers synchronize data across multiple clients and devices in a privacy-preserving way. All data saved in the user storage database is encrypted client-side to preserve privacy. The user storage provides a modular design, giving developers the flexibility to construct and manage their storage spaces in a way that best suits their needs",
"keywords": [
"MetaMask",
Expand Down
6 changes: 3 additions & 3 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3314,7 +3314,7 @@ __metadata:
"@metamask/base-controller": "npm:^6.0.2"
"@metamask/controller-utils": "npm:^11.0.2"
"@metamask/keyring-controller": "npm:^17.1.2"
"@metamask/profile-sync-controller": "npm:^0.2.0"
"@metamask/profile-sync-controller": "npm:^0.2.1"
"@types/jest": "npm:^27.4.1"
"@types/readable-stream": "npm:^2.3.0"
bignumber.js: "npm:^4.1.0"
Expand All @@ -3332,7 +3332,7 @@ __metadata:
uuid: "npm:^8.3.2"
peerDependencies:
"@metamask/keyring-controller": ^17.0.0
"@metamask/profile-sync-controller": ^0.2.0
"@metamask/profile-sync-controller": ^0.2.1
languageName: unknown
linkType: soft

Expand Down Expand Up @@ -3544,7 +3544,7 @@ __metadata:
languageName: unknown
linkType: soft

"@metamask/profile-sync-controller@npm:^0.2.0, @metamask/profile-sync-controller@workspace:packages/profile-sync-controller":
"@metamask/profile-sync-controller@npm:^0.2.1, @metamask/profile-sync-controller@workspace:packages/profile-sync-controller":
version: 0.0.0-use.local
resolution: "@metamask/profile-sync-controller@workspace:packages/profile-sync-controller"
dependencies:
Expand Down
Loading