Skip to content

Commit f04a8ea

Browse files
dario-piotrowiczalxhub
authored andcommitted
docs: move all bazel testing info to a single location (angular#46084)
instead of presenting the same (or similar information) in both the DEVELOPER.md and the BAZEL.md files, more all the information in the BAZEL file and refer to that section in the DEVELOPER file PR Close angular#46084
1 parent 390e989 commit f04a8ea

2 files changed

Lines changed: 17 additions & 17 deletions

File tree

docs/BAZEL.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,18 @@ new as of May 2017 and not very stable yet.
4848

4949
## Testing Angular
5050

51-
- Test package in node: `yarn bazel test packages/core/test:test`
52-
- Test package in karma: `yarn bazel test packages/core/test:test_web`
53-
- Test all packages: `yarn bazel test packages/...`
51+
- Test package in node: `yarn test packages/core/test:test`
52+
- Test package in karma: `yarn test packages/core/test:test_web`
53+
- Test all packages: `yarn test packages/...`
54+
55+
**Note**: The ellipsis in the last command above are not meant to be substituted by a package name, but
56+
are used by Bazel as a wildcard to execute all tests in the specified path. To execute all the tests for a
57+
single package, the commands are (exemplary):
58+
- `yarn test //packages/core/...` for all tests, or
59+
- `yarn test //packages/core/test:test` for a particular test suite.
60+
61+
**Note**: The first test run will be much slower than future runs. This is because future runs will
62+
benefit from Bazel's capability to do incremental builds.
5463

5564
You can use [ibazel] to get a "watch mode" that continuously
5665
keeps the outputs up-to-date as you save sources.

docs/DEVELOPER.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -74,24 +74,15 @@ node ./scripts/build/build-packages-dist.js
7474

7575
## Running Tests Locally
7676

77-
Bazel is used as the primary tool for building and testing Angular. Building and testing are
78-
incremental with Bazel, and it's possible to only run tests for an individual package instead
79-
of for all packages. Read more about this in the [BAZEL.md](./BAZEL.md) document.
77+
Bazel is used as the primary tool for building and testing Angular.
8078

81-
You should execute all test suites before submitting a PR to GitHub.
82-
- `yarn test //packages/...`
79+
To see how to run and debug Angular tests locally please refer to the Bazel [Testing Angular](./BAZEL.md#testing-angular) section.
8380

84-
**Note**: The ellipsis in the commands above is not meant to be substituted by a package name, but
85-
is used by Bazel as a wildcard to execute all tests in the specified path. To execute tests for a
86-
single package, the commands are (exemplary):
87-
- `yarn test //packages/core/...` for all tests, or
88-
- `yarn test //packages/core/test:test_web_firefox` for a particular test suite.
81+
Note that you should execute all test suites before submitting a PR to GitHub (`yarn test //packages/...`).
8982

90-
**Note**: The first test run will be much slower than future runs. This is because future runs will
91-
benefit from Bazel's capability to do incremental builds.
83+
However, affected tests will be executed on our CI infrastructure. So if you forgot to run some affected tests which would fail, GitHub will indicate the error state and present you the failures.
9284

93-
All the tests are executed on our Continuous Integration infrastructure. PRs can only be
94-
merged if the code is formatted properly and all tests are passing.
85+
PRs can only be merged if the code is formatted properly and all tests are passing.
9586

9687
<a name="formatting-your-source-code">
9788
<a name="clang-format"></a>

0 commit comments

Comments
 (0)