Github Pages deployment docs should clarify pnpm version is encouraged #12255
InertSloth
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
https://docs.astro.build/en/guides/deploy/github/
Per the discussion I had at withastro/action#80 with @delucis
The current documentation has you create this configuration portion in
deploy.yml
and a bit down the page this caution:
Even after the PR delucis made to allow the
package-manager
key to truly be optional, there is still a few issues here.package-manager: pnpm@latest
as a valid configuration, however as of the recent PR from delucis, this is not recommended per the warning Use latest PNPM version if not specified action#81Any documentation we add that mentions using
packageManager
withinpackage.json
opens a can of worms due to the field being associated with Corepack, which is still experimental, experimental and not always shipped. Both Yarn and Pnpm recommend installation via Corepack, but see their documentation for an amount of "troubleshooting" information for Corepack that would not likely fit in the astro action docs.https://pnpm.io/installation#using-corepack
https://yarnpkg.com/corepack
The configuration line and the caution do not mention needing to specify a
version
at all. As of delucis PR, this now works, with it defaulting to latest, but again, it will issue a warning pointing users to using corepack configuration instead. I feel the documentation could do a better job of highlighting that the version number is expected, not justlatest
.I'm not exactly sure how all the above should be navigated, but having recently gone through implementing this, I do feel the documentation here could do a much better job. Given there was several duplicate issues file concerning this specific configuration line, I seem not to be alone on this, and that's just those that bothered to file an issue about it.
How do people think we should proceed?
Beta Was this translation helpful? Give feedback.
All reactions