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 WRANGLER_CI_OVERRIDE_NAME for Workers CI #7990

Merged
merged 1 commit into from
Feb 5, 2025

Conversation

cmsparks
Copy link
Contributor

@cmsparks cmsparks commented Jan 31, 2025

Completes #[BANDA-631].

In Workers CI we'd like to override the Worker name being deployed to prevent the user from running into errors when deploying the wrong worker from their CI. This will force the worker being deployed to use the WRANGLER_CI_OVERRIDE_NAME environment variable (which is set by Workers Builds). This overrides the name used when running the wrangler deploy and wrangler versions upload commands.

I also added some information to the Wrangler output metadata, which provides information on whether the override was used and which environment was overridden for use by the Workers Builds API.


  • 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: tests included in the PR
  • Public documentation

Copy link

changeset-bot bot commented Jan 31, 2025

🦋 Changeset detected

Latest commit: 729d57e

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

This PR includes changesets to release 2 packages
Name Type
wrangler Patch
@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 Jan 31, 2025

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/13143163845/npm-package-wrangler-7990

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

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

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13143163845/npm-package-wrangler-7990 dev path/to/script.js
Additional artifacts:

cloudflare-workers-bindings-extension:

wget https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13143163845/npm-package-cloudflare-workers-bindings-extension-7990 -O ./cloudflare-workers-bindings-extension.0.0.0-v29668fcdd.vsix && code --install-extension ./cloudflare-workers-bindings-extension.0.0.0-v29668fcdd.vsix

create-cloudflare:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13143163845/npm-package-create-cloudflare-7990 --no-auto-update

@cloudflare/kv-asset-handler:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13143163845/npm-package-cloudflare-kv-asset-handler-7990

miniflare:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13143163845/npm-package-miniflare-7990

@cloudflare/pages-shared:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13143163845/npm-package-cloudflare-pages-shared-7990

@cloudflare/unenv-preset:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13143163845/npm-package-cloudflare-unenv-preset-7990

@cloudflare/vite-plugin:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13143163845/npm-package-cloudflare-vite-plugin-7990

@cloudflare/vitest-pool-workers:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13143163845/npm-package-cloudflare-vitest-pool-workers-7990

@cloudflare/workers-editor-shared:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13143163845/npm-package-cloudflare-workers-editor-shared-7990

@cloudflare/workers-shared:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13143163845/npm-package-cloudflare-workers-shared-7990

@cloudflare/workflows-shared:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13143163845/npm-package-cloudflare-workflows-shared-7990

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.20250129.0
workerd 1.20250129.0 1.20250129.0
workerd --version 1.20250129.0 2025-01-29

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

@cmsparks cmsparks force-pushed the csparks/wci-worker-name-override branch 5 times, most recently from 30b6e5d to a8ba110 Compare February 3, 2025 21:39
@cmsparks cmsparks changed the title Add WRANGLER_CI_NAME_OVERRIDE for Workers CI Add WRANGLER_CI_OVERRIDE_NAME for Workers CI Feb 3, 2025
@cmsparks cmsparks marked this pull request as ready for review February 3, 2025 21:46
@cmsparks cmsparks requested a review from a team as a code owner February 3, 2025 21:46
@cmsparks cmsparks force-pushed the csparks/wci-worker-name-override branch from a8ba110 to 80d4ce8 Compare February 3, 2025 21:53
packages/wrangler/src/__tests__/deploy.test.ts Outdated Show resolved Hide resolved
packages/wrangler/src/__tests__/output.test.ts Outdated Show resolved Hide resolved
packages/wrangler/src/deploy/index.ts Outdated Show resolved Hide resolved
packages/wrangler/src/versions/upload.ts Outdated Show resolved Hide resolved
packages/wrangler/src/versions/upload.ts Outdated Show resolved Hide resolved
@cmsparks cmsparks force-pushed the csparks/wci-worker-name-override branch 8 times, most recently from 0ada031 to ea859ce Compare February 4, 2025 18:13
@cmsparks cmsparks force-pushed the csparks/wci-worker-name-override branch from ea859ce to 729d57e Compare February 4, 2025 19:18
@cmsparks cmsparks requested a review from emily-shen February 4, 2025 19:34
@emily-shen emily-shen merged commit b1966df into main Feb 5, 2025
27 checks passed
@emily-shen emily-shen deleted the csparks/wci-worker-name-override branch February 5, 2025 15:11
@workers-devprod workers-devprod mentioned this pull request Feb 5, 2025
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.

2 participants