You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: DEV_ENVIRONMENT.md
+9-5Lines changed: 9 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,6 @@
1
1
# Developer guide: getting your environment set up
2
-
1. Make sure you have both `node` and `pnpm@9` installed.
2
+
3
+
1. Make sure you have both `node` and `pnpm` installed.
3
4
We recommend using `nvm` to manage your node versions.
4
5
2. If you are on Windows, see [the extra steps needed for contributing on Windows](#windows)
5
6
3. Fork the `angular/components` repo on GitHub.
@@ -8,13 +9,13 @@
8
9
and `<your-username>` for your fork. Also see the [team git shortcuts](https://github.com/angular/components/wiki/Team-git----bash-shortcuts).
9
10
5. From the root of the project, run `pnpm i` to install the dependencies.
10
11
11
-
12
12
To build angular/components in release mode, run `pnpm build`. The output can be found under `dist/releases`.
13
13
14
14
To bring up a local server, run `pnpm dev-app`. This will automatically watch for changes
15
15
and rebuild. The browser should refresh automatically when changes are made.
16
16
17
17
### Running tests
18
+
18
19
To run unit tests, run `pnpm test <target>`. The `target` can be either a short name (e.g. `pnpm test button`) or an explicit path `pnpm test src/cdk/stepper`.
19
20
To run the e2e tests, run `pnpm e2e`.
20
21
To run lint, run `pnpm lint`.
@@ -23,6 +24,7 @@ You can debug unit tests by running `pnpm test` with the `--debug` option. This
23
24
manually connect a browser to the Karma server.
24
25
25
26
### Getting Packages from Build Artifacts
27
+
26
28
Each CI run for a Pull Request stores the built Angular packages as
27
29
[build artifacts](https://circleci.com/docs/2.0/artifacts). The artifacts are not guaranteed to be
28
30
available as a long-term distribution mechanism, but they are guaranteed to be available around the
@@ -32,6 +34,7 @@ You can access the artifacts for a specific CI run by going to the workflow page
32
34
`upload_release_packages` job and then switching to the "Artifacts" tab.
33
35
34
36
#### Archives for each Package
37
+
35
38
On the "Artifacts" tab, there is a list of links to compressed archives for Angular packages. The
36
39
archive names are of the format `<package-name>-pr<pr-number>-<sha>.tgz` (for example
37
40
`material-pr12345-a1b2c3d.tgz`).
@@ -49,6 +52,7 @@ to point to the artifact URLs and then run `pnpm` to install the packages:
49
52
```
50
53
51
54
#### Download all Packages
55
+
52
56
In addition to the individual package archives, a `.tgz` file including all packages is also
53
57
available (named `all-pr<pr-number>-<sha>.tgz`). This can be used if one prefers to download all
54
58
packages locally and test them by either of the following ways:
@@ -57,14 +61,14 @@ packages locally and test them by either of the following ways:
57
61
2. Directly copy the local uncompressed package directories into the `node_modules/` directory
58
62
of a project.
59
63
60
-
61
64
### Approving public API changes
65
+
62
66
If you're making changes to a public API, they need to be propagated to our public API golden files.
63
67
To save the changes you can run `pnpm approve-api <target>` and to review the changes, you can look
64
68
at the file under `goldens/<package>/<entry-point>.api.md`.
65
69
66
-
67
70
### Disabling Git hooks
71
+
68
72
If your development workflow does not intend the commit message validation to run automatically
69
73
when commits are being created, or if you do not want to run the formatter upon `git commit`, you
70
74
can disable any installed Git hooks by setting `HUSKY=0` in your shell environment. e.g.
@@ -85,7 +89,7 @@ without requiring secrets to be committed.
85
89
86
90
The following variables are currently used in the dev-app:
87
91
88
-
*`GOOGLE_MAPS_KEY` - Optional key for the Google Maps API.
92
+
-`GOOGLE_MAPS_KEY` - Optional key for the Google Maps API.
89
93
90
94
For example, you can store a personal development Google Maps API key for the
0 commit comments