New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: move all bazel testing info to a single location #46084
docs: move all bazel testing info to a single location #46084
Conversation
- Test package in node: `yarn bazel test packages/core/test:test` | ||
- Test package in karma: `yarn bazel test packages/core/test:test_web` | ||
- Test all packages: `yarn bazel test packages/...` | ||
- Test package in node: `yarn test packages/core/test:test` | ||
- Test package in karma: `yarn test packages/core/test:test_web` | ||
- Test all packages: `yarn test packages/...` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bazel is used as the primary tool for building and testing Angular. Building and testing are | ||
incremental with Bazel, and it's possible to only run tests for an individual package instead | ||
of for all packages. Read more about this in the [BAZEL.md](./BAZEL.md) document. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think that explaining why bazel is used adds much here
docs/DEVELOPER.md
Outdated
|
||
**Note**: The first test run will be much slower than future runs. This is because future runs will | ||
benefit from Bazel's capability to do incremental builds. | ||
However the tests will be executed on our Continuous Integration infrastructure. So if you forgot to run the tests and some broke github will present you with the CI errors which you can then fix. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Honestly I have never run locally all the tests, on my (dinosaur) machine it would take ages, so I think it could be valuable to suggest to do that, but provide the alternative to rely on the CI
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Technically if you run everything once locally, you would get the same caching benefits as CI, but in practice this is obviously still slower. Just want to avoid recommend to rely fully on CI. Ideally folks would run some tests for the parts they have changed. e.g. if I change the compiler, I run tests in the compiler/test Bazel package.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah the first run is definitely my issue, after that the tests do run rather quick
anyways I hope that the wording here is fine then, sort of letting developers know that CI checks will be performed but not actively recommending to rely solely on that
docs/DEVELOPER.md
Outdated
|
||
**Note**: The first test run will be much slower than future runs. This is because future runs will | ||
benefit from Bazel's capability to do incremental builds. | ||
However the tests will be executed on our Continuous Integration infrastructure. So if you forgot to run the tests and some broke github will present you with the CI errors which you can then fix. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Technically if you run everything once locally, you would get the same caching benefits as CI, but in practice this is obviously still slower. Just want to avoid recommend to rely fully on CI. Ideally folks would run some tests for the parts they have changed. e.g. if I change the compiler, I run tests in the compiler/test Bazel package.
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
67ad7b9
to
d374fdf
Compare
Merge-assistance: the |
This PR was merged into the repository by commit f04a8ea. |
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 #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 #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 Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
Issue
Issue Number: N/A
Does this PR introduce a breaking change?
Other information
...
in the DEVELOPER one, which seemed quite valuable for the BAZEL file as well, instead of copy that section I just figured that the DEVELOPER's md should just point to the BAZEL one and that one should be the only point of reference (as it also contains various information for debugging)