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

Hotfix action #8192

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Hotfix action #8192

wants to merge 6 commits into from

Conversation

penalosa
Copy link
Contributor

@penalosa penalosa commented Feb 19, 2025

Fixes https://jira.cfdata.org/browse/DEVX-1231

This adds a manual action for triggering a hotfix release of Wrangler, Miniflare, or C3 outside of the regular changeset-based release process. It also includes instructions for how to prepare a hotfix release in the contributing guide.

Copy link

changeset-bot bot commented Feb 19, 2025

⚠️ No Changeset found

Latest commit: 7f63291

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@penalosa penalosa added the skip-pr-description-validation Skip validation of the required PR description format label Feb 19, 2025
Copy link
Contributor

github-actions bot commented Feb 19, 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/13434663777/npm-package-wrangler-8192

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

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

Or you can use npx with this latest build directly:

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

cloudflare-workers-bindings-extension:

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

create-cloudflare:

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

@cloudflare/kv-asset-handler:

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

miniflare:

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

@cloudflare/pages-shared:

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

@cloudflare/unenv-preset:

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

@cloudflare/vite-plugin:

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

@cloudflare/vitest-pool-workers:

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

@cloudflare/workers-editor-shared:

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

@cloudflare/workers-shared:

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

@cloudflare/workflows-shared:

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

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.20250214.0
workerd 1.20250214.0 1.20250214.0
workerd --version 1.20250214.0 2025-02-14

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

@penalosa penalosa marked this pull request as ready for review February 19, 2025 14:05
@penalosa penalosa requested a review from a team as a code owner February 19, 2025 14:05
- In general, the best way to do this is to checkout the previous release of `workers-sdk`, apply the changes you need, and then increment the patch version of the packages that should be released as part of this hotfix.

- Get approvals for that PR, and make sure CI checks are passing
- Manually trigger a hotfix release from that PR using the "Release a hotfix" GitHub action. Optionally, you can first publish it to the `hotfix` tag on NPM in order to verify the release.
Copy link
Contributor

Choose a reason for hiding this comment

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

"Optionally, you can first publish it to the hotfix tag on NPM in order to verify the release.
Comment"

is there a reason this shouldn't/can't be done? if no, i suggest we remove the "optionally" wording and explicitly direct to do this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's probably not really necessary, given we can test with the pre-release on the hotfix PR branch. We can likely remove this after we've merged and tested the hotfix workflow, but we need it for now so that we can run a test hotfix without overwriting npm latest

Copy link
Contributor

Choose a reason for hiding this comment

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

👍

if: ${{ inputs.confirm == true }}
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
Copy link
Contributor

Choose a reason for hiding this comment

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

would it make sense to check for user affiliation before checking out the repo?

penalosa and others added 2 commits February 20, 2025 11:53
Co-authored-by: Carmen Popoviciu <[email protected]>
- Prepare a hotfix release PR: checkout the previous release of `workers-sdk`, apply the changes that should be in the hotfix, and then increment the patch version of the packages that should be released as part of the hotfix

- Get approvals for that PR, and make sure CI checks are passing
- Manually trigger a hotfix release from that PR using the "Release a hotfix" GitHub action. Optionally, you can first publish it to the `hotfix` tag on NPM in order to verify the release.
Copy link
Contributor

@CarmenPopoviciu CarmenPopoviciu Feb 20, 2025

Choose a reason for hiding this comment

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

is it possible to link to where this action lives/or should be triggerred from?


- Get approvals for that PR, and make sure CI checks are passing
- Manually trigger a hotfix release from that PR using the "Release a hotfix" GitHub action. Optionally, you can first publish it to the `hotfix` tag on NPM in order to verify the release.
- _[CRUCIAL]_ Once the hotfix release is out and verified, merge the fixes into main before the next regular release of `workers-sdk`.
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't suppose we could automate this somehow 🤔 ... as in if a hotfix PR is released, a new PR to main with hotfix changes would be automatically created. Totally not in the scope of this PR...just thinking out loud

Copy link
Contributor

Choose a reason for hiding this comment

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

ooh yes +1

Copy link
Contributor

@CarmenPopoviciu CarmenPopoviciu left a comment

Choose a reason for hiding this comment

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

left some small nit comments, but LGTM overall. Up to you if you'd like to get an approval from Liz as well, since she seems to have reviewed yesterday

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-pr-description-validation Skip validation of the required PR description format
Projects
Status: Approved
Development

Successfully merging this pull request may close these issues.

3 participants