test(docs-infra): ensure RxJS-related docs examples can compile without errors by sonukapoor · Pull Request #34063 · angular/angular

sonukapoor · 2019-11-26T19:26:38Z

Some examples are simple typescript files. The changes in this PR make sure that they compile.

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our guidelines: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

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:

What is the current behavior?

Issue Number: #28017

What is the new behavior?

There is currently no way to validate code that is not an angular application e.g: The RxJS guide has no tests and no compilation steps. This PR adds a compilation step to at least validate the files.

Does this PR introduce a breaking change?

Yes
No

Other information

googlebot · 2019-11-26T19:26:41Z

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

sonukapoor · 2019-11-26T19:30:21Z

@googlebot I fixed it.

googlebot · 2019-11-26T19:46:37Z

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

gkalpak

Thx, @sonukapoor! This is looking great already. I left a couple of comments.
Also, can you please update the commit message to something like:

test(docs-infra): ensure RxJS-related docs examples can compile without errors

Previously, some RxJS-related examples (which are not proper Angular apps) were not
tested on CI as part of the example-e2e npm script. This meant that the examples
could get out-of-date or contain compile errors without as noticing.

This commit ensures that the example-e2e script picks up these examples and checks
that they compile successfully.

Partly addresses #28017.

_{This should not close #28017, because that one is about adding tests (which this PR does not do).}

sonukapoor · 2019-11-27T00:31:02Z

@gkalpak All changes done, except the package.json one. Please suggest what should be done on that part.

sonukapoor · 2019-11-28T18:19:01Z

@gkalpak I have reverted the @types/node in root and add it to the shared package.json file. I also had to upgrade @types/jquery to 3.3.28. Please review.

gkalpak

Great job, @sonukapoor 👏
Can you also please squash all commits together (and keep the commit message from a610a01be)?

…ut errors Previously, some RxJS-related examples (which are not proper Angular apps) were not tested on CI as part of the `example-e2e` npm script. This meant that the examples could get out-of-date or contain compile errors without as noticing. This commit ensures that the `example-e2e` script picks up these examples and checks that they compile successfully. Partly addresses angular#28017.

…e without errors

googlebot · 2019-11-28T20:02:21Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

gkalpak · 2019-11-28T20:03:49Z

@googlebot I consent.

googlebot · 2019-11-28T20:04:11Z

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

gkalpak · 2019-11-28T20:09:02Z

merge-assistance: Global approval for this docs(-infra)-only change.

…ut errors (#34063) Previously, some RxJS-related examples (which are not proper Angular apps) were not tested on CI as part of the `example-e2e` npm script. This meant that the examples could get out-of-date or contain compile errors without as noticing. This commit ensures that the `example-e2e` script picks up these examples and checks that they compile successfully. Partly addresses #28017. PR Close #34063

angular-automatic-lock-bot · 2020-01-03T16:05:25Z

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.}

sonukapoor requested a review from a team November 26, 2019 19:26

googlebot added the cla: no label Nov 26, 2019

sonukapoor force-pushed the compilation-validation-for-rxjs-examples branch from c8d87ba to 091109b Compare November 26, 2019 19:46

googlebot added cla: yes and removed cla: no labels Nov 26, 2019

sonukapoor force-pushed the compilation-validation-for-rxjs-examples branch 2 times, most recently from 70478f4 to 62032a9 Compare November 26, 2019 20:32

sonukapoor requested a review from a team November 26, 2019 20:32

gkalpak added comp: docs-infra state: WIP target: patch This PR is targeted for the next patch release labels Nov 26, 2019

ngbot Bot modified the milestone: needsTriage Nov 26, 2019

gkalpak suggested changes Nov 26, 2019

View reviewed changes

gkalpak suggested changes Nov 28, 2019

View reviewed changes

Comment thread aio/content/examples/observables/example-config.json Outdated

Comment thread aio/package.json Outdated

sonukapoor force-pushed the compilation-validation-for-rxjs-examples branch 3 times, most recently from 4a1da68 to 1a655a0 Compare November 28, 2019 17:39

gkalpak approved these changes Nov 28, 2019

View reviewed changes

Comment thread aio/yarn.lock Outdated

gkalpak added action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews and removed state: WIP labels Nov 28, 2019

sonukapoor force-pushed the compilation-validation-for-rxjs-examples branch 3 times, most recently from 5bfbf4c to 223ad81 Compare November 28, 2019 19:33

sonukapoor force-pushed the compilation-validation-for-rxjs-examples branch from 223ad81 to 1b8cf27 Compare November 28, 2019 19:41

sonukapoor force-pushed the compilation-validation-for-rxjs-examples branch from 1b8cf27 to a4fe600 Compare November 28, 2019 19:43

fixup! test(docs-infra): ensure RxJS-related docs examples can compil…

2c57350

…e without errors

googlebot added cla: no and removed cla: yes labels Nov 28, 2019

googlebot added cla: yes and removed cla: no labels Nov 28, 2019

mhevery closed this in 2cc954d Dec 2, 2019

gkalpak changed the title ~~docs: adds config to compile non-angular files~~ test(docs-infra): ensure RxJS-related docs examples can compile without errors Dec 2, 2019

sonukapoor deleted the compilation-validation-for-rxjs-examples branch December 3, 2019 20:08

angular-automatic-lock-bot Bot locked and limited conversation to collaborators Jan 3, 2020

Conversation

sonukapoor commented Nov 26, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

Uh oh!

googlebot commented Nov 26, 2019

Uh oh!

sonukapoor commented Nov 26, 2019

Uh oh!

googlebot commented Nov 26, 2019

Uh oh!

gkalpak left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonukapoor commented Nov 27, 2019

Uh oh!

Uh oh!

Uh oh!

sonukapoor commented Nov 28, 2019

Uh oh!

gkalpak left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

googlebot commented Nov 28, 2019

Uh oh!

gkalpak commented Nov 28, 2019

Uh oh!

googlebot commented Nov 28, 2019

Uh oh!

gkalpak commented Nov 28, 2019

Uh oh!

angular-automatic-lock-bot Bot commented Jan 3, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

sonukapoor commented Nov 26, 2019 •

edited

Loading

gkalpak left a comment •

edited

Loading