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.

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

docs: remove warning about packageManager and pnpm default #245

Merged
merged 4 commits into from
Mar 26, 2024

Conversation

Cherry
Copy link
Contributor

@Cherry Cherry commented Mar 25, 2024

This effectively reverts #242.


This is inferred by #190 and then fixed in #193, and I'm not really sure the "default" copy/pasted config should use pnpm - that's definitely not the standard.

The package manager you'd like to use to install and run wrangler. If not specified, the preferred package manager will be inferred based on the presence of a lockfile or fallback to using npm if no lockfile is found. Valid values are npm | pnpm | yarn | bun.

You do not need to specify packageManager as the docs now suggests, as long as you're running an up to date version.

If there is a bug in the package manager detection, I'd suggest that should be reported and addressed separately.

@Cherry Cherry requested a review from a team as a code owner March 25, 2024 22:06
@Cherry
Copy link
Contributor Author

Cherry commented Mar 25, 2024

cc @petebacondarwin

@@ -53,10 +52,6 @@ jobs:

## Configuration

### packageManager

⚠️ you must specify package manager. If not specified GH action assumes you are using npm and other managers might be failing. For example pnpm will fail with: `Cannot read properties of null (reading 'matches')`
Copy link
Contributor

Choose a reason for hiding this comment

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

I agree that we should drop this paragraph, but we should completely undocument the packageManager option. Instead of dropping this paragraph, could you please replace it with an a short blurb about packageManager option and how to use it (following the style for other options below). thanks

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The original intent here was mainly to just revert #242, but I've added a short blurb about packageManager under the "advanced usage" section since I figure most people won't ever need to touch this.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thank you, James!

@@ -31,7 +31,6 @@ jobs:
- name: Deploy
uses: cloudflare/wrangler-action@v3
with:
packageManager: pnpm # you can omit this if you use npm
Copy link
Contributor

@IgorMinar IgorMinar Mar 26, 2024

Choose a reason for hiding this comment

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

+1, we should shouldn't be forcing this on devs

Copy link
Contributor Author

Choose a reason for hiding this comment

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

typo, and I assume you mean "shouldn't"? If so, agreed!

Copy link
Contributor

Choose a reason for hiding this comment

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

oops.. yup. shouldn't

@@ -53,10 +52,6 @@ jobs:

## Configuration

### packageManager

⚠️ you must specify package manager. If not specified GH action assumes you are using npm and other managers might be failing. For example pnpm will fail with: `Cannot read properties of null (reading 'matches')`
Copy link
Contributor

Choose a reason for hiding this comment

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

Thank you, James!

README.md Outdated Show resolved Hide resolved
remote ws
README.md Show resolved Hide resolved
@Cherry
Copy link
Contributor Author

Cherry commented Mar 26, 2024

Thanks for the feedback @IgorMinar. I believe everything should be addressed now.

Sadly the tests here will fail due to the necessary secrets not existing in the PR. Reference: #216 (comment)

This PR only updates docs though, so should be safe to merge.

@IgorMinar IgorMinar merged commit fd98a7c into cloudflare:main Mar 26, 2024
2 of 3 checks passed
@IgorMinar
Copy link
Contributor

Thanks James. This reads much better! I've merged the PR.

@Cherry Cherry deleted the fix/packageManager branch March 26, 2024 22:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants