docs: move all bazel testing info to a single location by dario-piotrowicz · Pull Request #46084 · angular/angular · GitHub
Skip to content

docs: move all bazel testing info to a single location - #46084

Closed
dario-piotrowicz wants to merge 1 commit into
angular:mainfrom
dario-piotrowicz:BAZEL_DEVELOPER_TESTING
Closed

dario-piotrowicz wants to merge 1 commit into
angular:mainfrom
dario-piotrowicz:BAZEL_DEVELOPER_TESTING

Conversation

@dario-piotrowicz

Copy link
Copy Markdown
Contributor

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?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • angular.io application / infrastructure changes
  • Other... Please describe:

Issue

Issue Number: N/A

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

  • basically I've been referring to the BAZEL file, but stumbled across the explanation of the ... 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)

@pullapprove
pullapprove Bot requested a review from devversion May 21, 2022 17:18
Comment thread docs/BAZEL.md Outdated
Comment on lines 51 to 53

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that bazel is not necessary

actually the script seem to use bazelisk (I guess they are the same-ish?):
Screenshot at 2022-05-21 18-20-13

Comment thread docs/DEVELOPER.md Outdated
Comment on lines 77 to 79

Copy link
Copy Markdown
Contributor Author

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 🤔

Comment thread docs/DEVELOPER.md Outdated

Copy link
Copy Markdown
Contributor Author

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

Copy link
Copy Markdown
Member

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.

Copy link
Copy Markdown
Contributor Author

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 🙂

@dario-piotrowicz dario-piotrowicz changed the title docs: move all bazel testing into a single location docs: move all bazel testing info into a single location May 21, 2022
@dario-piotrowicz dario-piotrowicz changed the title docs: move all bazel testing info into a single location docs: move all bazel testing info to a single location May 21, 2022

@devversion devversion left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM overall

Comment thread docs/DEVELOPER.md Outdated

Copy link
Copy Markdown
Member

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.

Comment thread docs/DEVELOPER.md Outdated
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
@dario-piotrowicz
dario-piotrowicz force-pushed the BAZEL_DEVELOPER_TESTING branch from 67ad7b9 to d374fdf Compare May 23, 2022 18:18
@angular-robot
angular-robot Bot requested a review from devversion May 23, 2022 18:18
@AndrewKushnir AndrewKushnir added action: merge The PR is ready for merge by the caretaker target: patch This PR is targeted for the next patch release action: rerun CI at HEAD labels May 23, 2022
@ngbot ngbot Bot added this to the Backlog milestone May 23, 2022
@AndrewKushnir

Copy link
Copy Markdown
Contributor

Merge-assistance: the legacy-unit-tests-saucelabs CI failure is unrelated to the changes in this PR.

@AndrewKushnir AndrewKushnir added the merge: caretaker note Alert the caretaker performing the merge to check the PR for an out of normal action needed or note label May 23, 2022
@alxhub

alxhub commented May 23, 2022

Copy link
Copy Markdown
Member

This PR was merged into the repository by commit f04a8ea.

@alxhub alxhub closed this in f04a8ea May 23, 2022
alxhub pushed a commit that referenced this pull request May 23, 2022
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
alxhub pushed a commit that referenced this pull request May 23, 2022
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
@angular-automatic-lock-bot

Copy link
Copy Markdown

@angular-automatic-lock-bot angular-automatic-lock-bot Bot locked and limited conversation to collaborators Jun 23, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

action: merge The PR is ready for merge by the caretaker merge: caretaker note Alert the caretaker performing the merge to check the PR for an out of normal action needed or note target: patch This PR is targeted for the next patch release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants