Skip to content

Commit bc2e0d0

Browse files
authored
docs: remove specific pnpm version reference (#32074)
Replaces explicit "pnpm 9" mention with a general "pnpm" reference, as version 10 is now current and the docs should remain version-agnostic.
1 parent 3a43de9 commit bc2e0d0

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

DEV_ENVIRONMENT.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# 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.
34
We recommend using `nvm` to manage your node versions.
45
2. If you are on Windows, see [the extra steps needed for contributing on Windows](#windows)
56
3. Fork the `angular/components` repo on GitHub.
@@ -8,13 +9,13 @@
89
and `<your-username>` for your fork. Also see the [team git shortcuts](https://github.com/angular/components/wiki/Team-git----bash-shortcuts).
910
5. From the root of the project, run `pnpm i` to install the dependencies.
1011

11-
1212
To build angular/components in release mode, run `pnpm build`. The output can be found under `dist/releases`.
1313

1414
To bring up a local server, run `pnpm dev-app`. This will automatically watch for changes
1515
and rebuild. The browser should refresh automatically when changes are made.
1616

1717
### Running tests
18+
1819
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`.
1920
To run the e2e tests, run `pnpm e2e`.
2021
To run lint, run `pnpm lint`.
@@ -23,6 +24,7 @@ You can debug unit tests by running `pnpm test` with the `--debug` option. This
2324
manually connect a browser to the Karma server.
2425

2526
### Getting Packages from Build Artifacts
27+
2628
Each CI run for a Pull Request stores the built Angular packages as
2729
[build artifacts](https://circleci.com/docs/2.0/artifacts). The artifacts are not guaranteed to be
2830
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
3234
`upload_release_packages` job and then switching to the "Artifacts" tab.
3335

3436
#### Archives for each Package
37+
3538
On the "Artifacts" tab, there is a list of links to compressed archives for Angular packages. The
3639
archive names are of the format `<package-name>-pr<pr-number>-<sha>.tgz` (for example
3740
`material-pr12345-a1b2c3d.tgz`).
@@ -49,6 +52,7 @@ to point to the artifact URLs and then run `pnpm` to install the packages:
4952
```
5053

5154
#### Download all Packages
55+
5256
In addition to the individual package archives, a `.tgz` file including all packages is also
5357
available (named `all-pr<pr-number>-<sha>.tgz`). This can be used if one prefers to download all
5458
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:
5761
2. Directly copy the local uncompressed package directories into the `node_modules/` directory
5862
of a project.
5963

60-
6164
### Approving public API changes
65+
6266
If you're making changes to a public API, they need to be propagated to our public API golden files.
6367
To save the changes you can run `pnpm approve-api <target>` and to review the changes, you can look
6468
at the file under `goldens/<package>/<entry-point>.api.md`.
6569

66-
6770
### Disabling Git hooks
71+
6872
If your development workflow does not intend the commit message validation to run automatically
6973
when commits are being created, or if you do not want to run the formatter upon `git commit`, you
7074
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.
8589

8690
The following variables are currently used in the dev-app:
8791

88-
* `GOOGLE_MAPS_KEY` - Optional key for the Google Maps API.
92+
- `GOOGLE_MAPS_KEY` - Optional key for the Google Maps API.
8993

9094
For example, you can store a personal development Google Maps API key for the
9195
dev-app within your `.bashrc` or `.zshrc` file.

0 commit comments

Comments
 (0)