Skip to content

Commit 85c386e

Browse files
committed
docs: add sop for adding new routes to the worker
Signed-off-by: flakey5 <[email protected]>
1 parent ad5c16b commit 85c386e

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/sops/adding-new-routes.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Adding New Routes
2+
3+
Guide on how to add new routes for the Release Worker to handle.
4+
5+
This assumes:
6+
7+
- There has already been prior discussions regarding the new routes
8+
- A concensus has been reached on what routes are needed and how they are to function.
9+
10+
If there hasn't been a discussion, please [open a issue](https://github.com/nodejs/release-cloudflare-worker/issues/new) on this repository to discuss it.
11+
12+
## Steps
13+
14+
- Write the code/symlinks/... that handles the route and open a PR on this repository.
15+
- Please be intentional for any middleware that the new route is using. Verify that the middleware can handle that route.
16+
- Example: [#331](https://github.com/nodejs/release-cloudflare-worker/pull/331)
17+
- Open an issue on [nodejs/build](https://github.com/nodejs/build) requesting the new route be sent to the Release Worker
18+
- This can be done before or after the PR for the Release Worker is merged.
19+
- Example: [nodejs/build#4044](https://github.com/nodejs/build/issues/4044).
20+
21+
> [!IMPORTANT]
22+
> If the route is for new files included in a release, a release must be made with those files present before the PR here gets merged.

0 commit comments

Comments
 (0)