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

fix(wrangler): Display correct global flags in wrangler pages --help #5814

Merged
merged 1 commit into from
May 15, 2024

Conversation

CarmenPopoviciu
Copy link
Contributor

@CarmenPopoviciu CarmenPopoviciu commented May 13, 2024

What this PR solves / how to test

Running wrangler pages --help will list, amongst others, the following global flags:

Screenshot 2024-05-13 at 19 18 22

Some of these global flags however, such as --env, --config or --experimental-json-config, are not supported by Pages, and therefore listing them as if they were gets users confused.

This PR ensures we only list the relevant flags when running wrangler pages --help

Fixes #5725.

Before
wrangler --help
Screenshot 2024-05-13 at 19 18 22

wrangler pages --help
Screenshot 2024-05-13 at 19 27 59

After
wrangler --help
Screenshot 2024-05-13 at 19 18 22

wrangler pages --help
Screenshot 2024-05-13 at 19 24 59

wrangler pages dev --help
Screenshot 2024-05-13 at 19 25 34

Author has addressed the following

  • Tests
    • TODO (before merge)
    • Included
    • Not necessary because:
  • E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
    • I don't know
    • Required / Maybe required
    • Not required because: changes are covered by unit tests and that's enough
  • Changeset (Changeset guidelines)
    • TODO (before merge)
    • Included
    • Not necessary because:
  • Public documentation

@CarmenPopoviciu CarmenPopoviciu requested review from a team as code owners May 13, 2024 17:21
Copy link

changeset-bot bot commented May 13, 2024

🦋 Changeset detected

Latest commit: b324b6d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
wrangler Minor
@cloudflare/vitest-pool-workers Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

github-actions bot commented May 13, 2024

A wrangler prerelease is available for testing. You can install this latest build in your project with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9100082012/npm-package-wrangler-5814

You can reference the automatically updated head of this PR with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/prs/5814/npm-package-wrangler-5814

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9100082012/npm-package-wrangler-5814 dev path/to/script.js
Additional artifacts:
npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9100082012/npm-package-create-cloudflare-5814 --no-auto-update
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9100082012/npm-package-cloudflare-kv-asset-handler-5814
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9100082012/npm-package-miniflare-5814
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9100082012/npm-package-cloudflare-pages-shared-5814
npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/9100082012/npm-package-cloudflare-vitest-pool-workers-5814

Note that these links will no longer work once the GitHub Actions artifact expires.


wrangler@3.56.0 includes the following runtime dependencies:

Package Constraint Resolved
miniflare workspace:* 3.20240512.0
workerd 1.20240512.0 1.20240512.0
workerd --version 1.20240512.0 2024-05-12

Please ensure constraints are pinned, and miniflare/workerd minor versions match.

@CarmenPopoviciu CarmenPopoviciu force-pushed the carmen/global-flags branch 4 times, most recently from b4edbcc to 9eb077d Compare May 13, 2024 17:44
packages/wrangler/src/pages/deploy.tsx Outdated Show resolved Hide resolved
Copy link
Contributor

@petebacondarwin petebacondarwin left a comment

Choose a reason for hiding this comment

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

Subject to the wording change!

packages/wrangler/src/index.ts Show resolved Hide resolved
packages/wrangler/src/pages/deploy.tsx Outdated Show resolved Hide resolved
packages/wrangler/src/pages/dev.ts Outdated Show resolved Hide resolved
`wrangler pages --help` currently displays a list of global
flags that are not all supported by Pages, such as `--env`,
`--config`, and `--experimental-json-config`.

This commit ensure that only flags that apply to Pages are
listed when running `--help`.

Fixes #5725
@petebacondarwin petebacondarwin merged commit 2869e03 into main May 15, 2024
12 of 19 checks passed
@petebacondarwin petebacondarwin deleted the carmen/global-flags branch May 15, 2024 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

🐛 BUG: Some global flags listed by wrangler pages --help do not apply to Pages
3 participants