Skip to content

Commit ca5e942

Browse files
Document release process for workers-shared's asset-worker and router-worker (#8040)
1 parent 3b602fe commit ca5e942

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

packages/workers-shared/README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
This is a package that is used at Cloudflare to power some internal features of [Cloudflare Workers](https://developers.cloudflare.com/workers/), as well as their open-source equivalents here in workers-sdk and Wrangler.
44

5+
> [!NOTE]
6+
> Since code in this package is used by the Workers infrastructure, it is important that PRs are given careful review with regards to how they could cause a failure in production.
7+
> Ideally, there should be comprehensive tests for changes being made to give extra confidence about the behavior.
8+
59
## `asset-worker`
610

711
The Asset Worker.
@@ -14,6 +18,15 @@ The Router Worker.
1418

1519
For more details please refer to the dedicated README file.
1620

17-
> [!NOTE]
18-
> Since code in this package is used by the Workers infrastructure, it is important that PRs are given careful review with regards to how they could cause a failure in production.
19-
> Ideally, there should be comprehensive tests for changes being made to give extra confidence about the behavior.
21+
## `Worker Deployment`
22+
23+
Router-worker and asset-worker are both version uploaded through the run `deploy` target in this package, which uploads a new version of these Workers.
24+
25+
There are two ways that the `deploy` script target can be invoked:
26+
27+
- The `changesets` workflow will execute whenever there is a release of `@cloudflare/workers-shared`
28+
- If a change is needed prior to a workers-shared release, it can be done manually, via the `workers-shared-deploy-production` workflow. This workflow will upload new vesions of asset-worker and router-worker based on the code in the `main` branch. (Note, a duplicate version may be uploaded on the next workers-shared release, if there is an associated changeset)
29+
30+
The pnpm `deploy` script should not be run manually.
31+
32+
Once new versions are uploaded (through either the manual workflow, or the changesets workflow), they can be safely deployed and monitored using Gradual Deployments through Health Mediated Deployments.

0 commit comments

Comments
 (0)