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

pnpm support #1224

Merged

colincasey merged 8 commits into main from pnpm_support

Apr 29, 2024

Contributor

colincasey commented Mar 25, 2024 •

edited

These changes build on top of existing corepack support to allow pnpm to be installed via Corepack.

The buildpack has also been modified use the pnpm binary at the following stages:

installing dependencies
running build scripts:
- heroku-prebuild
- build (or heroku-postbuild)
- heroku-cleanup
pruning dev dependencies

Usage

As stated in the Corepack docs, setting the package manager to be used is done using the packageManager field in package.json:

{
  "packageManager": "pnpm@<version>"
}

It is also possible to specify the pnpm version in the engines.pnpm field of package.json:

{
  "engines": {
    "pnpm": "<version>"
  }
}

Notes

If the pnpm version is specified in both the packageManager and engines.pnpm field of package.json then the version specified in packageManager will be used and a warning will be displayed noting this.
If there is a pnpm lockfile detected but no packageManager and engines.pnpm field defined in package.json then the buildpack will install the lastest version of pnpm.

The PRs listed below enhance this baseline support:

colincasey self-assigned this

colincasey force-pushed the pnpm_support branch from 64a2f4d to 3678300 Compare

March 25, 2024 17:06

colincasey added a commit that referenced this pull request


          Add pnpm caching

1499fe1

These changes build on top of [existing pnpm support](#1224) to allow `pnpm` dependencies to be saved and restored between builds.

colincasey mentioned this pull request

Add pnpm caching #1225

Merged

colincasey force-pushed the pnpm_support branch from 3678300 to 0718093 Compare

March 25, 2024 18:00

colincasey added a commit that referenced this pull request


          Add pnpm caching

f8c6384

These changes build on top of [existing pnpm support](#1224) to allow `pnpm` dependencies to be saved and restored between builds.

colincasey added a commit that referenced this pull request


          pnpm support (default version)

3e0ee85

These changes build on top of [existing pnpm support](#1224) to default to the `latest` version when it appears that pnpm should be used but there is no `engines.pnpm` or `packageManager` specified in `package.json`.

colincasey mentioned this pull request

pnpm support (default version) #1226

Merged

colincasey added a commit that referenced this pull request


          pnpm support engines

1af0347

These changes build on top of [existing pnpm support](#1224) to use the version specified by the `engines.pnpm` field in `package.json`.

colincasey mentioned this pull request

pnpm support engines #1227

Merged

colincasey added a commit that referenced this pull request


          pnpm support engines

a668c7e

These changes build on top of [existing pnpm support](#1224) to use the version specified by the `engines.pnpm` field in `package.json`.

colincasey added a commit that referenced this pull request


          Multiple lockfiles error

ee4de17

These changes build on top of [existing pnpm support](#1224) and modify the failure message shown when multiple lockfiles are detected to now include pnpm.

colincasey mentioned this pull request

Multiple lockfiles error #1228

Merged

joshwlewis reviewed

View reviewed changes

lib/dependencies.sh Outdated Show resolved Hide resolved

joshwlewis reviewed

View reviewed changes

lib/dependencies.sh Outdated Show resolved Hide resolved

colincasey force-pushed the corepack_support branch 3 times, most recently from 213ab2e to 4de5c95 Compare

March 27, 2024 15:43

colincasey force-pushed the pnpm_support branch from 0718093 to 060ecd5 Compare

March 27, 2024 16:06

colincasey mentioned this pull request

pnpm support - periodic store pruning #1231

Merged

colincasey added a commit that referenced this pull request


          Multiple lockfiles error

0622abb

These changes build on top of [existing pnpm support](#1224) and modify the failure message shown when multiple lockfiles are detected to now include pnpm.

colincasey added a commit that referenced this pull request


          Add pnpm caching

424ffa2

These changes build on top of [existing pnpm support](#1224) to allow `pnpm` dependencies to be saved and restored between builds.

colincasey added a commit that referenced this pull request


          pnpm support (default version)

726e3a7

These changes build on top of [existing pnpm support](#1224) to default to the `latest` version when it appears that pnpm should be used but there is no `engines.pnpm` or `packageManager` specified in `package.json`.

colincasey added a commit that referenced this pull request


          pnpm support engines

These changes build on top of [existing pnpm support](#1224) to use the version specified by the `engines.pnpm` field in `package.json`.

colincasey added a commit that referenced this pull request


          pnpm support engines

b5b5240

These changes build on top of [existing pnpm support](#1224) to use the version specified by the `engines.pnpm` field in `package.json`.

colincasey force-pushed the corepack_support branch 2 times, most recently from 375fd1a to 6ac0c04 Compare

April 2, 2024 12:20

colincasey force-pushed the pnpm_support branch from 060ecd5 to a25345b Compare

April 2, 2024 12:22

colincasey added a commit that referenced this pull request


          Multiple lockfiles error

b903149

These changes build on top of [existing pnpm support](#1224) and modify the failure message shown when multiple lockfiles are detected to now include pnpm.

colincasey added a commit that referenced this pull request


          Add pnpm caching

9ed509c

These changes build on top of [existing pnpm support](#1224) to allow `pnpm` dependencies to be saved and restored between builds.

colincasey added a commit that referenced this pull request


          pnpm support (default version) (#1226)

7d55b53

These changes build on top of [existing pnpm support](#1224) to default to the `latest` version when it appears that pnpm should be used but there is no `engines.pnpm` or `packageManager` specified in `package.json`.

colincasey added a commit that referenced this pull request


          pnpm support engines (#1227)

2d6f643

These changes build on top of [existing pnpm support](#1224) to use the version specified by the `engines.pnpm` field in `package.json`.

l-campbell commented Apr 15, 2024

Thanks for working on this @colincasey! So excited to be able to make use of these changes

colincasey mentioned this pull request

Make pnpm an option (as well as the existing npm, yarn options) #688

Closed

Contributor Author

colincasey commented Apr 15, 2024

Thanks @l-campbell 😄

If you want to preview this in your application builds before it gets released, you can try it out today by swapping out the heroku/nodejs buildpack with one that references the pnpm_support branch:

heroku buildpacks:remove heroku/nodejs -a <your-appname>
heroku buildpacks:set https://github.com/heroku/heroku-buildpack-nodejs#pnpm_support -a <your-appname>

If you experience any build issues with pnpm during this preview phase, please file an issue and we'll do our best to address it before this PR is merged.

l-campbell commented Apr 18, 2024

Working like a dream @colincasey 🚀 👏

Any idea when this will land?

Contributor Author

colincasey commented Apr 23, 2024

Good to hear, @l-campbell. Thanks for giving it a try 😄

I can't give a specific time-frame for the release but it will be soon. I just have a couple of documentation tasks to complete first.

colincasey marked this pull request as ready for review

April 29, 2024 14:13

colincasey requested a review from a team as a code owner

April 29, 2024 14:14

colincasey enabled auto-merge (squash)

April 29, 2024 16:58

edmorley removed the request for review from a team

April 29, 2024 17:00

colincasey added a commit that referenced this pull request


          Multiple lockfiles error (#1228)

a1b9bf7

These changes build on top of [existing pnpm support](#1224) and modify the failure message shown when multiple lockfiles are detected to now include pnpm.

colincasey force-pushed the pnpm_support branch from 26b784b to 2419972 Compare

April 29, 2024 18:25

colincasey added a commit that referenced this pull request


          Add pnpm caching (#1225)

322861d

These changes build on top of [existing pnpm support](#1224) to allow `pnpm` dependencies to be saved and restored between builds.

colincasey added a commit that referenced this pull request


          pnpm support (default version) (#1226)

7c9844a

These changes build on top of [existing pnpm support](#1224) to default to the `latest` version when it appears that pnpm should be used but there is no `engines.pnpm` or `packageManager` specified in `package.json`.

colincasey added a commit that referenced this pull request


          pnpm support engines (#1227)

bb06100

These changes build on top of [existing pnpm support](#1224) to use the version specified by the `engines.pnpm` field in `package.json`.

colincasey force-pushed the pnpm_support branch from 2419972 to 26b784b Compare

April 29, 2024 18:25

colincasey added 8 commits

April 29, 2024 15:26


          pnpm support

e45e886

These changes build on top of [existing corepack support](#1222) to allow `pnpm` to be installed via [Corepack](https://nodejs.org/docs/latest/api/corepack.html).

The build process has also been modified use the `pnpm` binary at the following stages:
- installing dependencies
- running build scripts:
  - `heroku-prebuild`
  - `build` (or `heroku-postbuild`)
  - `heroku-cleanup`
- pruning dev dependencies


          Prune the pnpm store periodically (#1231)

4d34865


          Multiple lockfiles error (#1228)

af79a32

These changes build on top of [existing pnpm support](#1224) and modify the failure message shown when multiple lockfiles are detected to now include pnpm.


          Add pnpm caching (#1225)

f034c27

These changes build on top of [existing pnpm support](#1224) to allow `pnpm` dependencies to be saved and restored between builds.


          pnpm support (default version) (#1226)

These changes build on top of [existing pnpm support](#1224) to default to the `latest` version when it appears that pnpm should be used but there is no `engines.pnpm` or `packageManager` specified in `package.json`.


          pnpm support engines (#1227)

65f1f90

These changes build on top of [existing pnpm support](#1224) to use the version specified by the `engines.pnpm` field in `package.json`.


          Only prune when it's safe to do so (#1238)

1ea795e


          Update CHANGELOG.md

8f5e651

colincasey force-pushed the pnpm_support branch from 26b784b to 8f5e651 Compare

April 29, 2024 18:26

colincasey merged commit f045fd7 into main

11 checks passed

colincasey deleted the pnpm_support branch

April 29, 2024 18:52

heroku-linguist bot mentioned this pull request

Prepare release v245 #1246

Merged

Jolg42 mentioned this pull request

When using pnpm and deploying Prisma Client to Heroku, it fails at runtime with Cannot find module '.prisma/client' prisma/prisma#24199

Open

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment