Skip to content

Conversation

ericcrosson-bitgo
Copy link
Contributor

The motivation behind this commit is to reduce the amount of
noise currently printed by npm install in the root of this
repository. Installing npm dependencies currently prints the following:

$ npm ci

> @api-ts/[email protected] postinstall
> patch-package

patch-package 8.0.0
Applying patches...
@semantic-release/[email protected] ✔

Warning: patch-package detected a patch file version mismatch

  Don't worry! This is probably fine. The patch was still applied
  successfully. Here's the deets:

  Patch file created for

    @semantic-release/[email protected]

  applied to

    @semantic-release/[email protected]

  At path

    node_modules/@semantic-release/npm

  This warning is just to give you a heads-up. There is a small chance of
  breakage even though the patch was applied successfully. Make sure the package
  still behaves like you expect (you wrote tests, right?) and then run

    patch-package @semantic-release/npm

  to update the version in the patch file name and make this warning go away.

It looks like we created a patch for version
@semantic-release/[email protected], and have since updated (probably through
Dependabot) to @semantic-release/[email protected].

The underlying dependency doesn't seem to have changed in a way that
invalidates our patch, so I followed patch-package's instruction
and ran:

node_modules/.bin/patch-package @semantic-release/npm

This commit adds the generated file to version control. It also removes
the patch configured to run on @semantic-release/[email protected], since that
version is no longer installed in this repository (and removing this file
is necessary to silence the patch-package warning).

@ericcrosson-bitgo ericcrosson-bitgo marked this pull request as ready for review July 27, 2025 17:28
@ericcrosson-bitgo ericcrosson-bitgo requested a review from a team as a code owner July 27, 2025 17:28
The motivation behind this commit is to reduce the amount of
noise currently printed by `npm install` in the root of this
repository. Installing npm dependencies currently prints the following:

```
$ npm ci

> @api-ts/[email protected] postinstall
> patch-package

patch-package 8.0.0
Applying patches...
@semantic-release/[email protected] ✔

Warning: patch-package detected a patch file version mismatch

  Don't worry! This is probably fine. The patch was still applied
  successfully. Here's the deets:

  Patch file created for

    @semantic-release/[email protected]

  applied to

    @semantic-release/[email protected]

  At path

    node_modules/@semantic-release/npm

  This warning is just to give you a heads-up. There is a small chance of
  breakage even though the patch was applied successfully. Make sure the package
  still behaves like you expect (you wrote tests, right?) and then run

    patch-package @semantic-release/npm

  to update the version in the patch file name and make this warning go away.
```

It looks like we created a patch for version
@semantic-release/[email protected], and have since updated (probably through
Dependabot) to @semantic-release/[email protected].

The underlying dependency doesn't seem to have changed in a way that
invalidates our patch, so I followed patch-package's instruction
and ran:

```sh
node_modules/.bin/patch-package @semantic-release/npm
```

This commit adds the generated file to version control. It also removes
the patch configured to run on @semantic-release/[email protected], since that
version is no longer installed in this repository (and removing this file
is necessary to silence the patch-package warning).

Update: and then I moved the comment over... you know, I could have just
renamed the file!
@ericcrosson-bitgo ericcrosson-bitgo force-pushed the build-update-patch-package-patch-file branch from 2cf662e to 83435c9 Compare July 27, 2025 17:31
@ericcrosson-bitgo ericcrosson-bitgo merged commit 3dc2545 into BitGo:master Jul 28, 2025
6 checks passed
@ericcrosson-bitgo ericcrosson-bitgo deleted the build-update-patch-package-patch-file branch July 28, 2025 15:17
Copy link

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

Copy link

github-actions bot commented Aug 1, 2025

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

Copy link

github-actions bot commented Aug 1, 2025

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants