Skip to content
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: ensure examples get rxjs ^5.5.0 #19985

Closed
wants to merge 1 commit into from

Conversation

wardbell
Copy link
Contributor

@wardbell wardbell commented Oct 27, 2017

URGENT - please merge ASAP as we have very little time to update docs before next NG release.

Added patch label as well; RxJS v.5.5 is backward compat for Ng v4

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)
[x] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] angular.io application / infrastructure changes
[ ] Other... Please describe:

What is the current behavior?

All doc samples get there node_modules from one place, .../aio/tools/shared/examples/package.json.

This package.json and its yarn.lock are currently pinned to RxJS <5.5 so we can't show or explain the RxJS features that we should now be recommending to everyone.

In user land, people using the CLI are getting 5.5.x today.

Issue Number: #19510 concerning upgrading Docs for v5 Angular and latest CLI

What is the new behavior?

Installs latest RxJS >= 5.5.0

Although the focus is strictly RxJS, the regenerated yarn.lock updates all other package dependencies currently specified in package.json.

That is unintentional but probably a good thing as we should be consistent.
If something goes wrong with this, we will fix it.

Does this PR introduce a breaking change?

[ ] Yes
[x] No - won't affect AIO. Should not affect samples. If it does, we must fix

@wardbell wardbell self-assigned this Oct 27, 2017
@wardbell wardbell added comp: docs target: patch This PR is targeted for the next patch release labels Oct 27, 2017
@mary-poppins
Copy link

You can preview 9a8f049 at https://pr19985-9a8f049.ngbuilds.io/.

@gkalpak gkalpak added this to the v5.0.0 milestone Oct 27, 2017
@gkalpak
Copy link
Member

gkalpak commented Oct 27, 2017

This updates all dependencies, not just RxJS. If that is intentional, it should be reflected in the commit message.

@wardbell
Copy link
Contributor Author

wardbell commented Oct 27, 2017

@gkalpak Huh? Only for samples. All sample are already governed by .../tools/shared/examples/package.js.

Oh ... I see. You mean it will update versions of other packages in package.json that were implied but not installed because existing yarn.lock pinned them. You are correct. That should be OK and if it isn't, we must fix.

I'll be more explicit in the main comment.

Also updated the commit message accordingly

This change coincidentally updates other packages that were in `package.json`
because it regenerates `yarn.lock`. This too should be fine.
@mary-poppins
Copy link

You can preview fca0ed1 at https://pr19985-fca0ed1.ngbuilds.io/.

@gkalpak gkalpak added the action: merge The PR is ready for merge by the caretaker label Oct 27, 2017
matsko pushed a commit that referenced this pull request Oct 28, 2017
This change coincidentally updates other packages that were in `package.json`
because it regenerates `yarn.lock`. This too should be fine.

PR Close #19985
@matsko matsko closed this in 2f63899 Oct 28, 2017
wardbell added a commit to IdeaBlade/angular that referenced this pull request Oct 28, 2017
@wardbell wardbell deleted the aio-examples-rxjs-5-5 branch October 28, 2017 19:50
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 12, 2019
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 cla: yes target: patch This PR is targeted for the next patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants