ci: easy pre-releases for new packages #4757

mrbbot · 2024-01-16T15:24:52Z

What this PR solves / how to test:

I'm planning to put a PR up for Miniflare 3's new Vitest unit-testing environment soon. This is going to be a separate @cloudflare/vitest-pool-workers package. While the PR is being reviewed, it would be nice to have pre-releases of the package available.

Currently, we have two pre-release workflows, one that's triggered on pull requests to build pre-releases and publish them as artifacts, and then another that's triggered from main when the first completes to write pre-release URLs to a sticky comment. Both of these workflows must be updated to add a new package to the pre-release registry.

As the 2nd workflow is triggered from main, a separate PR to add @cloudflare/vitest-pool-workers to the comment would be needed, before the PR implementing the package could be put up. When packages have dependencies on other pre-released packages, these dependencies must be hardcoded in the workflow too.

This change allows any package to be included in the pre-release registry by adding "workers-sdk": { "prerelease": true } to its package.json. Any dependencies that are also marked as pre-releasable are automatically updated to point to the correct pre-release URL.

Author has addressed the following:

Tests
- Included
- Not necessary because: changing GitHub actions workflows
Changeset (Changeset guidelines)
- Included
- Not necessary because: no user facing changes, just changing internal workflows
Associated docs
- Issue(s)/PR(s):
- Not necessary because: no user facing changes, just changing internal workflows

Note for PR author:

We want to celebrate and highlight awesome PR review! If you think this PR received a particularly high-caliber review, please assign it the label highlight pr review so future reviewers can take inspiration and learn from it.

changeset-bot · 2024-01-16T15:24:56Z

⚠️ No Changeset found

Latest commit: 565b549

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

codecov · 2024-01-16T15:31:27Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (42ad768) 75.66% compared to head (565b549) 71.83%.
Report is 18 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4757      +/-   ##
==========================================
- Coverage   75.66%   71.83%   -3.84%     
==========================================
  Files         243      285      +42     
  Lines       13226    14761    +1535     
  Branches     3396     3719     +323     
==========================================
+ Hits        10008    10603     +595     
- Misses       3218     4158     +940

see 60 files with indirect coverage changes

packages/create-cloudflare/package.json

GregBrimble

Nice improvement!

Expose ACTIONS_RUNTIME_TOKEN and ACTIONS_RESULTS_URL variables

Switch to `workers-sdk` object in `package.json`

github-actions · 2024-01-17T12:16:41Z

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/7584753028/npm-package-wrangler-4757

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

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

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/7584753028/npm-package-wrangler-4757 dev path/to/script.js

Additional artifacts:

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

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

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

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

wrangler@3.23.0 includes the following runtime dependencies:

Package	Constraint	Resolved
`miniflare`	workspace:*	3.20231218.2
`workerd`	1.20231218.0	1.20231218.0
`workerd --version`	1.20231218.0	2023-12-18

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

dario-piotrowicz · 2024-01-18T17:56:54Z

.github/prereleases/3-comment.mjs

+	assert.strictEqual(name, "wrangler");
+	const url = getPrereleaseArtifactUrl(name);
+	const prUrl = getPrereleasePRArtifactUrl(name);
+	return `A wrangler prerelease is available for testing. You can install this latest build in your project with:


I am not a big fan of the markdown being all included here like so (and all the backticks escapes)

I am fine with it, but hopefully we can come up with something more convenient at some point 🙂

Also I've disliked the prerelease comment for a while and I did try to update it 😅

It's not something really related to this PR, but yeah I'd love it if we could improve the comment/report as a whole, I just figured I'd mention it here 😄

That's fair. Could consider extracting the comment into a template file and using something like Handlebars? Although, given we don't modify the template that much, it might not be worth the additional complexity.

Yes, I was thinking of something like handlebars as well 🙂

But it was just a thought, I actually don't think we should overthink this in this PR and increase it's scope, I'm 100% fine with the current implementation, I just wanted to mention that it'd be nice maybe later at some point to improve things 🙂

Captured in #4790 🙂

dario-piotrowicz · 2024-01-18T18:08:03Z

@mrbbot sorry it is a bit unrelated... 😅

But in the runtime versions we sometimes get an extra |, as you can see in this PRs prerelease comment
#4757 (comment):

Since you're already touching the prerelease could you also amend that? 🙂
Once I looked into this and I remember that the issue was an extra \n that we were getting and this change fixed it: https://github.com/cloudflare/workers-sdk/pull/4090/files#r1457812880

dario-piotrowicz

Looks great to me! 🤩

I just left a few very very minor nitpicks 😅

Remove extraneous `|` in pre-release comment

mrbbot · 2024-01-18T18:14:38Z

@dario-piotrowicz Fixed that | issue in 6f9e2be

.github/prereleases/0-packages.mjs

.github/prereleases/1-versions.mjs

.github/prereleases/3-comment.mjs

dario-piotrowicz · 2024-01-19T13:04:20Z

.github/prereleases/0-packages.mjs

+
+/** @returns {~Package[]} */
+export function getPackagesForPrerelease() {
+	return getPackages().filter((pkg) => pkg.json["workers-sdk"]?.prerelease);


Just a quick idea, It doesn't need to be implemented in this PR but I wanted to mention it 🙂

This function gets all the packages that have the prerelease field regardless on whether they have been modified in the PR or not (at least that's my understanding)

Could we improve this by checking using git if files within the package have changes and if not, not generate a prerelease for it at all?

This is a good idea, I've captured it along with other suggestions in #4790 🙂

Simplify validation/extraction of `githubPullRequestNumber`

Use `forEach` instead of `for of`

Explain why we need custom action for extracting action variables

mrbbot requested review from a team as code owners January 16, 2024 15:24

mrbbot force-pushed the bcoll/generic-prereleases branch from f74b979 to c02d18c Compare January 16, 2024 15:25

GregBrimble reviewed Jan 16, 2024

View reviewed changes

packages/create-cloudflare/package.json Outdated Show resolved Hide resolved

GregBrimble approved these changes Jan 16, 2024

View reviewed changes

mrbbot added 3 commits January 17, 2024 12:13

ci: easy pre-releases for new packages

666c962

fixup! ci: easy pre-releases for new packages

2c7dab2

Expose ACTIONS_RUNTIME_TOKEN and ACTIONS_RESULTS_URL variables

fixup! ci: easy pre-releases for new packages

4f1129a

Switch to `workers-sdk` object in `package.json`

mrbbot force-pushed the bcoll/generic-prereleases branch from 426db8a to 4f1129a Compare January 17, 2024 12:14

dario-piotrowicz reviewed Jan 18, 2024

View reviewed changes

dario-piotrowicz approved these changes Jan 18, 2024

View reviewed changes

fixup! ci: easy pre-releases for new packages

6f9e2be

Remove extraneous `|` in pre-release comment

GregBrimble mentioned this pull request Jan 18, 2024

Bring across @cloudflare/kv-asset-handler #4782

Merged

petebacondarwin approved these changes Jan 19, 2024

View reviewed changes

.github/prereleases/0-packages.mjs Outdated Show resolved Hide resolved

.github/prereleases/0-packages.mjs Show resolved Hide resolved

.github/prereleases/1-versions.mjs Outdated Show resolved Hide resolved

.github/prereleases/3-comment.mjs Show resolved Hide resolved

dario-piotrowicz reviewed Jan 19, 2024

View reviewed changes

mrbbot added 3 commits January 19, 2024 13:35

fixup! ci: easy pre-releases for new packages

32cb043

Simplify validation/extraction of `githubPullRequestNumber`

fixup! ci: easy pre-releases for new packages

96d8497

Use `forEach` instead of `for of`

fixup! ci: easy pre-releases for new packages

888f3c9

Explain why we need custom action for extracting action variables

mrbbot mentioned this pull request Jan 19, 2024

Pre-release process improvements #4790

Open

fixup! fixup! ci: easy pre-releases for new packages

565b549

mrbbot merged commit f860aba into main Jan 19, 2024
22 checks passed

mrbbot deleted the bcoll/generic-prereleases branch January 19, 2024 14:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ci: easy pre-releases for new packages #4757

ci: easy pre-releases for new packages #4757

mrbbot commented Jan 16, 2024 •

edited

Loading

changeset-bot bot commented Jan 16, 2024 •

edited

Loading

codecov bot commented Jan 16, 2024 •

edited

Loading

GregBrimble left a comment

github-actions bot commented Jan 17, 2024 •

edited

Loading

dario-piotrowicz Jan 18, 2024

dario-piotrowicz Jan 18, 2024

mrbbot Jan 18, 2024

dario-piotrowicz Jan 18, 2024

mrbbot Jan 19, 2024

dario-piotrowicz commented Jan 18, 2024

dario-piotrowicz left a comment •

edited

Loading

mrbbot commented Jan 18, 2024

dario-piotrowicz Jan 19, 2024

mrbbot Jan 19, 2024

ci: easy pre-releases for new packages #4757

ci: easy pre-releases for new packages #4757

Conversation

mrbbot commented Jan 16, 2024 • edited Loading

changeset-bot bot commented Jan 16, 2024 • edited Loading

⚠️ No Changeset found

codecov bot commented Jan 16, 2024 • edited Loading

Codecov Report

GregBrimble left a comment

Choose a reason for hiding this comment

github-actions bot commented Jan 17, 2024 • edited Loading

dario-piotrowicz Jan 18, 2024

Choose a reason for hiding this comment

dario-piotrowicz Jan 18, 2024

Choose a reason for hiding this comment

mrbbot Jan 18, 2024

Choose a reason for hiding this comment

dario-piotrowicz Jan 18, 2024

Choose a reason for hiding this comment

mrbbot Jan 19, 2024

Choose a reason for hiding this comment

dario-piotrowicz commented Jan 18, 2024

dario-piotrowicz left a comment • edited Loading

Choose a reason for hiding this comment

mrbbot commented Jan 18, 2024

dario-piotrowicz Jan 19, 2024

Choose a reason for hiding this comment

mrbbot Jan 19, 2024

Choose a reason for hiding this comment

mrbbot commented Jan 16, 2024 •

edited

Loading

changeset-bot bot commented Jan 16, 2024 •

edited

Loading

codecov bot commented Jan 16, 2024 •

edited

Loading

github-actions bot commented Jan 17, 2024 •

edited

Loading

dario-piotrowicz left a comment •

edited

Loading