Skip to content

Commit

Permalink
chore: change wrangler-devtools name to workers-devtools
Browse files Browse the repository at this point in the history
chore: add changeset

chore: update lock file

chore: update formatting

chore: fix snapshot tests
  • Loading branch information
andyjessop committed Nov 19, 2024
1 parent edec415 commit 98f42ef
Show file tree
Hide file tree
Showing 21 changed files with 48 additions and 43 deletions.
5 changes: 5 additions & 0 deletions .changeset/mighty-waves-deny.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@cloudflare/chrome-devtools-patches": patch
---

change package name from @cloudflare/wrangler-devtools to @cloudflare/chrome-devtools-patches
12 changes: 6 additions & 6 deletions .github/workflows/deploy-pages-previews.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ name: Deploy Pages Previews
#
# PR Label | Pages Project
# ---------------------------------------------------------
# preview:wrangler-devtools | packages/wrangler-devtools
# preview:chrome-devtools-patches | packages/chrome-devtools-patches
# preview:quick-edit | packages/quick-edit
# preview:workers-playground | packages/workers-playground
#
Expand All @@ -25,7 +25,7 @@ jobs:
# Only run this on PRs that are for the "cloudflare" org and not "from" `main`
# - non-Cloudflare PRs will not have the secrets needed
# - PRs "from" main would accidentally do a production deployment
if: github.repository_owner == 'cloudflare' && github.head_ref != 'main' && (contains(github.event.*.labels.*.name, 'preview:wrangler-devtools') || contains(github.event.*.labels.*.name, 'preview:quick-edit') || contains(github.event.*.labels.*.name, 'preview:workers-playground'))
if: github.repository_owner == 'cloudflare' && github.head_ref != 'main' && (contains(github.event.*.labels.*.name, 'preview:chrome-devtools-patches') || contains(github.event.*.labels.*.name, 'preview:quick-edit') || contains(github.event.*.labels.*.name, 'preview:workers-playground'))
timeout-minutes: 60
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
Expand All @@ -49,9 +49,9 @@ jobs:
CI_OS: ${{ runner.os }}

- name: Deploy Wrangler DevTools preview
if: contains(github.event.*.labels.*.name, 'preview:wrangler-devtools')
if: contains(github.event.*.labels.*.name, 'preview:chrome-devtools-patches')
run: |
output=$(pnpm --filter @cloudflare/wrangler-devtools run deploy)
output=$(pnpm --filter @cloudflare/chrome-devtools-patches run deploy)
echo "Extracting deployed URL from command output"
url=$(echo "$output" | grep -oP 'Take a peek over at \K\S+')
echo "Extracted URL: $url"
Expand Down Expand Up @@ -80,7 +80,7 @@ jobs:
VITE_DEVTOOLS_PREVIEW_URL: ${{ env.VITE_DEVTOOLS_PREVIEW_URL }}

- name: "Comment on PR with Devtools Link"
if: contains(github.event.*.labels.*.name, 'preview:wrangler-devtools')
if: contains(github.event.*.labels.*.name, 'preview:chrome-devtools-patches')
uses: marocchino/sticky-pull-request-comment@v2
with:
header: ${{ steps.finder.outputs.pr }}
Expand All @@ -99,7 +99,7 @@ jobs:
```
- name: "Comment on PR with Workers Playground Link"
if: contains(github.event.*.labels.*.name, 'preview:wrangler-devtools') && contains(github.event.*.labels.*.name, 'preview:workers-playground')
if: contains(github.event.*.labels.*.name, 'preview:chrome-devtools-patches') && contains(github.event.*.labels.*.name, 'preview:workers-playground')
uses: marocchino/sticky-pull-request-comment@v2
with:
header: ${{ steps.finder.outputs.pr }}
Expand Down
16 changes: 8 additions & 8 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -188,14 +188,14 @@ packages/quick-edit/vscode
packages/quick-edit/web

packages/wrangler/config-schema.json
packages/wrangler-devtools/built-devtools
packages/wrangler-devtools/.cipd
packages/wrangler-devtools/.gclient
packages/wrangler-devtools/.gclient_entries
packages/wrangler-devtools/.gclient_previous_sync_commits
packages/wrangler-devtools/.gcs_entries
packages/wrangler-devtools/depot
packages/wrangler-devtools/devtools-frontend
packages/chrome-devtools-patches/built-devtools
packages/chrome-devtools-patches/.cipd
packages/chrome-devtools-patches/.gclient
packages/chrome-devtools-patches/.gclient_entries
packages/chrome-devtools-patches/.gclient_previous_sync_commits
packages/chrome-devtools-patches/.gcs_entries
packages/chrome-devtools-patches/depot
packages/chrome-devtools-patches/devtools-frontend
packages/miniflare/dist-types/

fixtures/remix-pages-app/public/build
Expand Down
2 changes: 1 addition & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ packages/create-cloudflare/templates*/**/*.*
# but still exclude the worker-configuration.d.ts file, since it's generated
!packages/create-cloudflare/templates*/hello-world/**/*.*
packages/create-cloudflare/templates*/hello-world/**/worker-configuration.d.ts
packages/wrangler-devtools/devtools-frontend
packages/chrome-devtools-patches/devtools-frontend

# dist-functions are generated in the fixtures/vitest-pool-workers-examples/pages-functions-unit-integration-self folder
dist-functions
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ Changes should be committed to a new local branch, which then gets pushed to you
git push -u origin <new-branch-name>
```
- Once you are happy with your changes, create a Pull Request on GitHub
- The format for Pull Request titles is `[package name] description`, where the package name should indicate which package of the `workers-sdk` monorepo your PR pertains to (e.g. `wrangler`/`pages-shared`/`wrangler-devtools`), and the description should be a succinct summary of the change you're making.
- The format for Pull Request titles is `[package name] description`, where the package name should indicate which package of the `workers-sdk` monorepo your PR pertains to (e.g. `wrangler`/`pages-shared`/`chrome-devtools-patches`), and the description should be a succinct summary of the change you're making.
- GitHub will insert a template for the body of your Pull Request—it's important to carefully fill out all the fields, giving as much detail as possible to reviewers.

## PR Review
Expand All @@ -215,7 +215,7 @@ Every PR will have an associated pre-release build for all releaseable packages

It's also possible to generate preview builds for the applications in the repository. These aren't generated automatically because they're pretty slow CI jobs, but you can trigger preview builds by adding one of the following labels to your PR:

- `preview:wrangler-devtools` for deploying [wrangler-devtools](packages/wrangler-devtools)
- `preview:chrome-devtools-patches` for deploying [chrome-devtools-patches](packages/chrome-devtools-patches)
- `preview:workers-playground` for deploying [workers-playground](packages/workers-playground)
- `preview:quick-edit` for deploying [quick-edit](packages/quick-edit)

Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,13 @@ Visit the official Workers documentation [here](https://developers.cloudflare.co

## Directory

| Package | Description | Links |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
| [`wrangler`](https://github.com/cloudflare/workers-sdk/tree/main/packages/wrangler) | A command line tool for building [Cloudflare Workers](https://workers.cloudflare.com/). | [Docs](https://developers.cloudflare.com/workers/wrangler/) |
| [`create-cloudflare` (C3)](https://github.com/cloudflare/workers-sdk/tree/main/packages/create-cloudflare) | A CLI for creating and deploying new applications to Cloudflare. | [Docs](https://developers.cloudflare.com/pages/get-started/c3/) |
| [`miniflare`](https://github.com/cloudflare/workers-sdk/tree/main/packages/miniflare) | A simulator for developing and testing Cloudflare Workers, powered by [workerd](https://github.com/cloudflare/workerd) | [Docs](https://miniflare.dev) |
| [`wrangler-devtools`](https://github.com/cloudflare/workers-sdk/tree/main/packages/wrangler-devtools) | Cloudflare's fork of Chrome DevTools for inspecting your local or remote Workers | |
| [`pages-shared`](https://github.com/cloudflare/workers-sdk/tree/main/packages/pages-shared) | Used internally to power Wrangler and Cloudflare Pages. It contains all the code that is shared between these clients. | |
| Package | Description | Links |
| ----------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
| [`wrangler`](https://github.com/cloudflare/workers-sdk/tree/main/packages/wrangler) | A command line tool for building [Cloudflare Workers](https://workers.cloudflare.com/). | [Docs](https://developers.cloudflare.com/workers/wrangler/) |
| [`create-cloudflare` (C3)](https://github.com/cloudflare/workers-sdk/tree/main/packages/create-cloudflare) | A CLI for creating and deploying new applications to Cloudflare. | [Docs](https://developers.cloudflare.com/pages/get-started/c3/) |
| [`miniflare`](https://github.com/cloudflare/workers-sdk/tree/main/packages/miniflare) | A simulator for developing and testing Cloudflare Workers, powered by [workerd](https://github.com/cloudflare/workerd) | [Docs](https://miniflare.dev) |
| [`chrome-devtools-patches`](https://github.com/cloudflare/workers-sdk/tree/main/packages/chrome-devtools-patches) | Cloudflare's fork of Chrome DevTools for inspecting your local or remote Workers | |
| [`pages-shared`](https://github.com/cloudflare/workers-sdk/tree/main/packages/pages-shared) | Used internally to power Wrangler and Cloudflare Pages. It contains all the code that is shared between these clients. | |

## Contributing

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @cloudflare/wrangler-devtools
# @cloudflare/chrome-devtools-patches

## 0.1.0

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Wrangler Devtools Pages Project
# Workers Devtools Pages Project

This package contains a Workers specific version of Chrome Devtools that is used by the Wrangler dev command. It is a customized fork of Chrome DevTools specifically tailored for debugging Cloudflare Workers. This package provides Worker-specific functionality through carefully maintained patches on top of Chrome DevTools.
This package contains a Workers specific version of Chrome Devtools that is used by the Wrangler dev command and other applications. It is a customized fork of Chrome DevTools specifically tailored for debugging Cloudflare Workers. This package provides Worker-specific functionality through carefully maintained patches on top of Chrome DevTools.

## Overview

Expand Down Expand Up @@ -56,8 +56,8 @@ On any pull request to the repo on GitHub, you can add labels to trigger preview

There are two labels you can use:

- `preview:wrangler-devtools` - this will trigger the DevTools preview
- `preview:wrangler-playground` - this will trigger the Playground preview
- `preview:chrome-devtools-patches` - this will trigger the DevTools preview
- `preview:workers-playground` - this will trigger the Playground preview

If you add **both** labels, Playground will embed the DevTools preview, so you can test them together.

Expand Down Expand Up @@ -86,7 +86,7 @@ When making changes:
Deployments are managed by GitHub Actions:

- deploy-pages-previews.yml:
- Runs on any PR that has the `preview:wrangler-devtools` label.
- Runs on any PR that has the `preview:chrome-devtools-patches` label.
- Deploys a preview, which can then be accessed via [https://<SHA>.cloudflare-devtools.pages.dev/].
- changesets.yml:
- Runs when a "Version Packages" PR, containing a changeset that touches this package, is merged to `main`.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "@cloudflare/wrangler-devtools",
"name": "@cloudflare/chrome-devtools-patches",
"version": "0.1.0",
"private": true,
"description": "Chrome Devtools hosted for easy use with Wrangler",
"description": "Chrome Devtools hosted for easy use with Workers tooling and applications (Wrangler, Playground, Quick Editor).",
"homepage": "https://github.com/cloudflare/workers-sdk#readme",
"bugs": {
"url": "https://github.com/cloudflare/workers-sdk/issues"
Expand Down
18 changes: 9 additions & 9 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ describe("findDeployablePackageNames()", () => {
}) => {
expect(findDeployablePackageNames()).toMatchInlineSnapshot(`
Set {
"@cloudflare/chrome-devtools-patches",
"devprod-status-bot",
"edge-preview-authenticated-proxy",
"format-errors",
Expand All @@ -108,7 +109,6 @@ describe("findDeployablePackageNames()", () => {
"@cloudflare/workers-shared",
"workers.new",
"@cloudflare/workflows-shared",
"@cloudflare/wrangler-devtools",
}
`);
});
Expand Down
2 changes: 1 addition & 1 deletion tools/deployments/__tests__/validate-changesets.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ describe("findPackageNames()", () => {
}) => {
expect(findPackageNames()).toMatchInlineSnapshot(`
Set {
"@cloudflare/chrome-devtools-patches",
"create-cloudflare",
"devprod-status-bot",
"edge-preview-authenticated-proxy",
Expand All @@ -40,7 +41,6 @@ describe("findPackageNames()", () => {
"workers.new",
"@cloudflare/workflows-shared",
"wrangler",
"@cloudflare/wrangler-devtools",
}
`);
});
Expand Down

0 comments on commit 98f42ef

Please sign in to comment.