docs: update contribution docs for serving a local library/project#47421
docs: update contribution docs for serving a local library/project#47421fabioemoutinho wants to merge 1 commit intoangular:mainfrom
Conversation
|
@alan-agius4 thank you for the information in #46771. Here's the PR to update docs. :) |
@josephperrott thanks for reviewing so quickly! Is there anything I need to do on my end? There are some failing tests but I think they are not related to this PR's changes |
docs/DEVELOPER.md
Outdated
There was a problem hiding this comment.
| Possible commands are: | |
| - `node --preserve-symlinks node_modules/.bin/ng s` | |
| - `set BAZEL_TARGET="1" && node --preserve-symlinks "node_modules/.bin/ng" s` | |
| - `set BAZEL_TARGET="1" && node --preserve-symlinks node_modules/@angular/cli/lib/init.js s` |
Windows
set BAZEL_TARGET="1" && node --preserve-symlinks node_modules/@angular/cli/lib/init.js serveUnix Systems
BAZEL_TARGET="1" node --preserve-symlinks "node_modules/.bin/ng serve
There was a problem hiding this comment.
I didn't have to use BAZEL_TARGET="1" on my machine, is there a specific scenario where it is needed?
There was a problem hiding this comment.
In case you need packages to be NGCC'd. Nowadays however this should rarely be the case. Maybe we can just omit this.
There was a problem hiding this comment.
Or add an explanation below:
"If packages do not need to go through NGCC (link with more context about ngcc?) there is no need to set BAZEL_TARGET."
There was a problem hiding this comment.
@alan-agius4 just waiting your input on this 😬
alan-agius4
left a comment
There was a problem hiding this comment.
Thanks for this. I couple of minor suggestions to make it clear.
@alan-agius4 Requested changes addressed. There's only one thing I'd still like to be clear though: #47421 (comment) |
alan-agius4
left a comment
There was a problem hiding this comment.
LGTM, thanks for this.
CI is failing because the last commit has double fixup! can you please address that?
Absolutely. Is it fine if I rebase and force push a new ref with one commit? |
Yes |
4b31604 to
e1f1cf7
Compare
alan-agius4
left a comment
There was a problem hiding this comment.
LGTM, thanks for your contribution.
|
This PR was merged into the repository by commit 8654e5c. |
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
#46771
when trying to build Angular packages locally for the first time, there's a knowledge barrier that is difficult to overcome. It is not explicit anywhere that you should disable the Angular CLI cache in your app, which causes serving an app to use cached builds of the local Angular packages, and also there's no explicit information other than in issue #46771 that explains how to run
ng serve. This PR is an attempt to add that information to the documentation.Issue Number: #46771
What is the new behavior?
Added information to DEVELOPER.md
Does this PR introduce a breaking change?
Other information
Please review or contribute and I'll gladly update the PR, this is my first PR.