Add messaging for CLI pages command being in Beta #661
Conversation
🦋 Changeset detectedLatest commit: eb18517 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
|
A wrangler prerelease is available for testing. You can install this latest build in your project with: npm install --save-dev https://prerelease-registry.developers.workers.dev/runs/2035403003/npm-package-wrangler-661You can reference the automatically updated head of this PR with: npm install --save-dev https://prerelease-registry.developers.workers.dev/prs/661/npm-package-wrangler-661Or you can use npx https://prerelease-registry.developers.workers.dev/runs/2035403003/npm-package-wrangler-661 dev path/to/script.js |
JacobMGEvans
force-pushed
the
jacobmgevans/wrangler-pages-beta
branch
from
84745ef to
aa4072f
Compare
JacobMGEvans
added
pages
JacobMGEvans
force-pushed
the
jacobmgevans/wrangler-pages-beta
branch
from
aa4072f to
4013901
Compare
threepointone
changed the title
packages/wrangler/src/index.tsx
Outdated
| .command(subHelp) | ||
| .epilog( | ||
| chalk.yellow( | ||
| "'wrangler pages <command>' is a Beta command. Please report any issues to https://github.com/cloudflare/wrangler2/issues/new/choose" |
There was a problem hiding this comment.
will this message show for every pages command?
There was a problem hiding this comment.
Yes. It run anytime the command is utilized.
If that is too often, alternatively, it could be added in the help message.
There was a problem hiding this comment.
Doesn't seem to when I'm testing?
npx wrangler pages --help
'wrangler pages <command>' is a Beta command. Please report any issues to https://github.com/cloudflare/wrangler2/issues/new/choose
npx wrangler pages dev --help
No warning message.
npx wrangler pages dev <dir>
No warning message.
There was a problem hiding this comment.
good catch, retracting my stamp
There was a problem hiding this comment.
I will add more comprehensive testing around it, and fix that.
There was a problem hiding this comment.
unit testing subcommands was not feasible, but the tests in examples showed it working as expected on subcommand usage.
Screenshots added to PR
|
Wrangler Pages command, --help flag and subcommands showing beta message
|
JacobMGEvans
force-pushed
the
jacobmgevans/wrangler-pages-beta
branch
from
4013901 to
2705611
Compare
JacobMGEvans
force-pushed
the
jacobmgevans/wrangler-pages-beta
branch
from
2705611 to
f8391e9
Compare
| "pages", | ||
| "⚡️ Configure Cloudflare Pages", | ||
| async (pagesYargs) => { | ||
| await pages(pagesYargs.command(subHelp).epilogue(pagesBetaWarning)); |
JacobMGEvans
force-pushed
the
jacobmgevans/wrangler-pages-beta
branch
from
f8391e9 to
bb9a72f
Compare
JacobMGEvans
force-pushed
the
jacobmgevans/wrangler-pages-beta
branch
from
bb9a72f to
eb18517
Compare
|
Looks like legitimate CI failures. |
JacobMGEvans
force-pushed
the
jacobmgevans/wrangler-pages-beta
branch
from
eb18517 to
2edcba0
Compare
In #661, we wrote a test, but didn't actually test if the error gets thrown. Being explicit about the thrown error shows that the error doesn't get thrown, and the warning doesn't get logged.
* bug: `wrangler pages functions` does not log a beta warning In #661, we wrote a test, but didn't actually test if the error gets thrown. Being explicit about the thrown error shows that the error doesn't get thrown, and the warning doesn't get logged. * Added option to Pages subcommand Function to trigger error message and check for beta message Co-authored-by: Jacob M-G Evans <jacobmgevans@gmail.com>
Adding "Beta" messaging around the CLI command for Pages.
Explicitly specifying the command is Beta, not to be confused with Pages itself which is production ready, the messaging could need additional tweaking to prevent any confusion between
Pagesandnpx wrangler pages <command>@nevikashah
resolves #642