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

Jump to bottom

17.1.0 #337

Merged
merged 4 commits into from
Jun 27, 2024
Merged

17.1.0 #337

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a53a9ae
17.1.0
invalid-email-address Jun 26, 2024
4353487
Update CHANGELOG.md
MajorLift Jun 26, 2024
8f88598
Update CHANGELOG.md
MajorLift Jun 26, 2024
f269685
Update CHANGELOG.md
MajorLift Jun 27, 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
21 changes: 20 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [17.1.0]
mcmire marked this conversation as resolved.
Show resolved Hide resolved

### Changed

- Bump `@metamask/json-rpc-middleware-stream` from `^7.0.1` to `^8.0.0` ([#327](https://github.com/MetaMask/providers/pull/327))
- Bump `@metamask/json-rpc-engine` from `^8.0.2` to `^9.0.0` ([#328](https://github.com/MetaMask/providers/pull/328))
- Bump `extension-port-stream` from `^3.0.0` to `^4.1.0` ([#331](https://github.com/MetaMask/providers/pull/331))
- Bump `@metamask/utils` from `^8.4.0` to `^8.5.0` ([#329](https://github.com/MetaMask/providers/pull/329))
- Bump `@metamask/rpc-errors` from `^6.2.1` to `^6.3.0` ([#326](https://github.com/MetaMask/providers/pull/326))
Comment on lines +14 to +18
Copy link
Member

Choose a reason for hiding this comment

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

I had thought it was our practice to ignore dependency updates in the changelog. I do have a hard time imagning how it could be relevant to consumers unless the update would be breaking by some other measure. @MajorLift @mcmire what's your thinking about this?

Copy link
Contributor

Choose a reason for hiding this comment

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

It's been our practice to ignore dev dependencies, but not non-dev dependencies. Perhaps this is something we only do in the core repo and not elsewhere — but my thought is that it's useful to be able to look back at when a dependency was intentionally introduced or upgraded in case it causes an issue that we weren't aware of later on. Do you think this is information that can be gleaned elsewhere if need be?

Copy link
Contributor

Choose a reason for hiding this comment

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

Adding to the above, on core, we have a reviewing-release-prs doc that specifies dependency bumps as needing to be captured in the changelog.

I think it's useful information to record in principle, but can get a bit noisy. Being able to record only the "important" bumps would be nice, but I guess to achieve the benefit @mcmire pointed out -- looking back to find the source of an error we didn't know about beforehand -- we can't pick and choose which bumps to record.


### Fixed
MajorLift marked this conversation as resolved.
Show resolved Hide resolved
- Produce and export ESM-compatible TypeScript type declaration files in addition to CommonJS-compatible declaration files ([#336](https://github.com/MetaMask/providers/pull/336))
- This fixes the issue of this package being unusable by any TypeScript project that uses `Node16` or `NodeNext` as its `moduleResolution` option.
- Previously, this package shipped with only one variant of type declaration files, and these files were only CommonJS-compatible, and the `exports` field in `package.json` linked to these files. This is an anti-pattern and was rightfully flagged by the ["Are the Types Wrong?"](https://arethetypeswrong.github.io/) tool as ["masquerading as CJS"](https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/FalseCJS.md). All of the ATTW checks now pass.
MajorLift marked this conversation as resolved.
Show resolved Hide resolved
- Remove chunk files ([#336](https://github.com/MetaMask/providers/pull/336)).
- Previously, the build tool we used to generate JavaScript files extracted common code to "chunk" files. While this was intended to make this package more tree-shakeable, it also made debugging more difficult for our development teams. These chunk files are no longer present.
- Use named `extension-port-stream` import to ensure compatibility with bundlers such as Vite ([#331](https://github.com/MetaMask/providers/pull/331))

## [17.0.0]

### Changed
Expand Down Expand Up @@ -403,7 +421,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
added deprecation warnings for them ([#30](https://github.com/MetaMask/providers/pull/30))
- Un-deprecated `sendAsync` ([#29](https://github.com/MetaMask/providers/pull/29))

[Unreleased]: https://github.com/MetaMask/providers/compare/v17.0.0...HEAD
[Unreleased]: https://github.com/MetaMask/providers/compare/v17.1.0...HEAD
[17.1.0]: https://github.com/MetaMask/providers/compare/v17.0.0...v17.1.0
[17.0.0]: https://github.com/MetaMask/providers/compare/v16.1.0...v17.0.0
[16.1.0]: https://github.com/MetaMask/providers/compare/v16.0.0...v16.1.0
[16.0.0]: https://github.com/MetaMask/providers/compare/v15.0.0...v16.0.0
Expand Down
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/providers",
"version": "17.0.0",
"version": "17.1.0",
"description": "A JavaScript Ethereum provider that connects to the wallet over a stream",
"keywords": [
"MetaMask",
Expand Down
Loading