Update example-basic-pnpm.yml

[tordans]

Having those hints inline saves quite a bit of research.

• Add hint how to omit setting the pnpm version explicitly
• Add hint that use-node-version is not supported yet

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[cypress-app-bot]

• Create a Draft Pull Request if your PR is not ready for review. Mark the PR as Ready for Review when you're ready for a Cypress team member to review the PR.

[MikeMcC399]

@tordans

Thank you for your submission to add comments to .github/workflows/example-basic-pnpm.yml!

If you would like the Cypress.io team to consider your submission, you would need to sign the CLA agreement.

In terms of the content, the workflow does already include links to the action repositories:

• https://github.com/pnpm/action-setup
• https://github.com/actions/setup-node

The workflow comments are intended to support a minimal working example and not cover all variations. Details of the actions used can change over time and adding more detail brings in the risk that the added detail of external actions may become inaccurate over time. We rely on the external action documentation being kept up to date and for users to refer to that up to date documentation.

My preference would be to not add this detail for the above reasons. You can wait to see if the Cypress.io team also responds.

[MikeMcC399]

https://nodejs.org/api/corepack.html lists this feature as experimental and not suitable for production.

Stability: 1 - Experimental. The feature is not subject to semantic versioning rules. Non-backward compatible changes or removal may occur in any future release. Use of the feature is not recommended in production environments.

[tordans]

Interesting. However since the action has documentation on supporting it, they will still lookup the information from there, even if packageManager is not an official property anymore, right?

[MikeMcC399]

actions/setup-node#1130 is an open enhancement request

This isn't really the right place to be listing an enhancement request for an external action, when this isn't used in the example.

[tordans]

My point was to link to some place that explains that there is no way to set the node version based on the config that pnpm supports. I don't see a better place where this is documented.

[MikeMcC399]

Some in-line comments also added.

[tordans]

Some in-line comments also added.

Thanks. I understand if those code comments are not in line with what you want in your example. Feel free to close this PR in this case.

[MikeMcC399]

@tordans

Thanks. I understand if those code comments are not in line with what you want in your example. Feel free to close this PR in this case.

Thanks for understanding that we try to keep the documentation as lean as possible for maintainability reasons.

I'm going to close this PR now. Thank you nevertheless for your proposal!