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

Add additional output fields to pages deployments #6990

Merged

Conversation

courtney-sims
Copy link
Contributor

@courtney-sims courtney-sims commented Oct 15, 2024

What this PR solves / how to test

cloudflare/wrangler-action#300

Adds additional outputs to wrangler's artifact mechanism for pages deploys. This allows wrangler-action to pull from wrangler's artifacts to get info about pages deploys, adding parity to the outputs pages-action provides.

Test by installing the wrangler prerelease in a local pages project, setting WRANGLER_OUTPUT_FILE_DIRECTORY in the local environment, running a pages deploy, and checking the output file.

Author has addressed the following

  • Tests
    • TODO (before merge)
    • Tests included
    • Tests not necessary because:
  • E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
    • I don't know
    • Required
    • Not required because: This code is not covered by those tests.
  • Changeset (Changeset guidelines)
    • TODO (before merge)
    • Changeset included
    • Changeset not necessary because:
  • Public documentation
    • TODO (before merge)
    • Cloudflare docs PR(s):
    • Documentation not necessary because: Internal usage for now

Copy link

changeset-bot bot commented Oct 15, 2024

🦋 Changeset detected

Latest commit: 9724518

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 Oct 15, 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/11369247844/npm-package-wrangler-6990

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

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

Or you can use npx with this latest build directly:

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

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


[email protected] includes the following runtime dependencies:

Package Constraint Resolved
miniflare workspace:* 3.20241011.0
workerd 1.20241011.1 1.20241011.1
workerd --version 1.20241011.1 2024-10-11

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

@courtney-sims courtney-sims changed the title Add additional outputs to pages deployments Add additional output fields to pages deployments Oct 15, 2024
@courtney-sims courtney-sims marked this pull request as ready for review October 15, 2024 19:48
@courtney-sims courtney-sims requested review from a team as code owners October 15, 2024 19:48
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.

Thanks @courtney-sims.

You'll need a changeset and some tests. See https://github.com/cloudflare/workers-sdk/blob/09b50927a62731f8aa621b9d872d10d1900a60a5/packages/wrangler/src/__tests__/output.test.ts

But also I think it might be safest if you create a new OutputEntry, rather than updating a current one. These entries are a contract between Wrangler and other tools that have an expectation of what is in the entry. Although this is adding new fields so would probably not break a downstream client of the output, you might have a situation where a client expects fields to be there which are not?

Either way, I think that the wrangler-action would need to ensure that the version of Wranger being used was new enough that this output included these fields.

packages/wrangler/src/pages/deploy.tsx Outdated Show resolved Hide resolved
@courtney-sims courtney-sims force-pushed the pages-action-output-parity branch 3 times, most recently from 7459b44 to b76f463 Compare October 16, 2024 15:01
@courtney-sims courtney-sims force-pushed the pages-action-output-parity branch 2 times, most recently from 5528699 to 9724518 Compare October 16, 2024 15:49
@CarmenPopoviciu CarmenPopoviciu merged commit 586c253 into cloudflare:main Oct 16, 2024
34 of 35 checks passed
@courtney-sims courtney-sims deleted the pages-action-output-parity branch October 16, 2024 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants