b2c8fb3c6b
This moves the commit step to the start of the process and releases after merging it. This has two key benefits: 1. The commit history now reflects the actual release (ex. any DevTools commits before the release commit are actually included in that release). Previously the changes in a release were dictated by the release PR branch, which is an ephemeral target. Other PRs may be merged to `main` before the release PR, and those changes would not be included in that DevTools release. 2. We can now compute a changelog based on this more accurate history. The downside to this change is that release PRs are now blocking releases in a way they weren't before (which is likely desirable in the grand scheme of things), meaning we need to be more diligent about merging them in a timely manner. I added a short script for listing DevTools commits since the last release, taking advantage of the more accurate commit history. This should make changelog generation a lot easier, even if there's still a manual process of rewriting the commit message into a line item in release notes. Also made a few minor cleanup changes such as escaping the markdown in the suggested reviewer note so it can be more easily copy-pasted from the rendered format of this doc. PR Close #60646 |
||
|---|---|---|
| .. | ||
| cypress | ||
| docs | ||
| projects | ||
| src | ||
| tools | ||
| .gitignore | ||
| BUILD.bazel | ||
| cypress.json | ||
| README.md | ||
| tsconfig.json | ||
| tsconfig.spec.json | ||
| tslint.json | ||
Angular DevTools
Angular DevTools is a browser DevTools extension for debugging and profiling Angular applications.
Developing Locally
Set up
Follow the instructions below to set up your Angular DevTools development
environment. Note that all commands should be executed in the repository root, not
devtools/. All file paths are also relative to the repository root.
Debian Linux, MacOS, and Windows via WSL should build successfully. Building natively on Windows without WSL is not supported at the moment.
To set up your development environment, first install the correct version of Node. If you have
nvm set up, this can be done with:
nvm install
Second, install Yarn:
npm install -g yarn@1
Third, install NPM dependencies:
yarn --frozen-lockfile
Now you should be ready to build the DevTools extension.
Dev builds
To run the extension in development mode run:
yarn devtools:devserver
You can also run a standalone version of the demo app with:
yarn devtools:devserver:demo-standalone
This would start a development server that you can access on http://localhost:4200. In development, Angular DevTools uses a "development shell." This is different from "chrome shell" in a way, that it runs the user's app in an iframe. DevTools then communicate with the user's app via message passing.
Release builds
You can build the release version of Angular DevTools for either Chrome or Firefox with:
yarn devtools:build:chrome
yarn devtools:build:firefox
Either way, the built extension will be at dist/bin/devtools/projects/shell-browser/src/prodapp.
Installation
For Chrome, you can install the extension from dist/bin/devtools/projects/shell-browser/src/prodapp by following the
guide from here.
For Firefox, to load the extension, you can go to the about:debugging page, click the "This Firefox" option and then
click the Load Temporary Add-on button. You'll have to select the manifest file in
dist/bin/devtools/projects/shell-browser/src/prodapp directly.