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.

Sign up for GitHub

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

Jump to bottom

refactor(ivy): Update @publicApi to @codeGenApi on ivy instructions #29820

Closed
wants to merge 1 commit into from
Closed

refactor(ivy): Update @publicApi to @codeGenApi on ivy instructions #29820

wants to merge 1 commit into from

Conversation

benlesh
Copy link
Contributor

@benlesh benlesh commented Apr 10, 2019 •
edited

  • Removes @publicApi annotation from ivy instructions
  • Adds new @codeGenApi annotation to ivy instructions
  • Updates ts_api_guardian to support the new annotation properly

@benlesh benlesh added refactoring Issue that involves refactoring or code-cleanup target: major This PR is targeted for the next major release comp: ivy risk: low labels Apr 10, 2019
@ngbot ngbot bot added this to the needsTriage milestone Apr 10, 2019
@benlesh benlesh marked this pull request as ready for review April 10, 2019 21:31
@benlesh benlesh requested review from a team as code owners April 10, 2019 21:31
@benlesh
Copy link
Contributor Author

benlesh commented Apr 10, 2019 •
edited

presubmit

@benlesh
refactor(ivy): Update @publicapi to @codeGenApi on ivy instructions
ba59453 
- Removes `@publicApi` annotation from ivy instructions
- Adds new `@codeGenApi` annotation to ivy instructions
- Updates ts_api_guardian to support the new annotation properly
@benlesh benlesh changed the title refactor(ivy): Update @publicApi to @generatedInstructionApi on ivy i… refactor(ivy): Update @publicApi to @codeGenApi on ivy instructions Apr 10, 2019
@jbogarthyde
Copy link
Contributor

This should keep these out of the AIO API doc. They don't look public, so I assume that is the intention?

@mary-poppins
Copy link

You can preview e024bd7 at https://pr29820-e024bd7.ngbuilds.io/.
You can preview 929c3ba at https://pr29820-929c3ba.ngbuilds.io/.
You can preview ba59453 at https://pr29820-ba59453.ngbuilds.io/.

gkalpak
gkalpak approved these changes Apr 11, 2019
View reviewed changes
Copy link
Member

@gkalpak gkalpak left a comment

Choose a reason for hiding this comment

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

The PR LGTM, except I don't understand:

  • Where is @codeApiGen defined. Assuming it is not yet defined and will defined in the future, what does it do.
  • Why are some Δ-prefixed function/interfaces/etc. still kept as @publicApi? (E.g. inject, defineInjectable/defineInjector, sanitizeHtml and co.)
  • What is the motivation fro the commit (other than that @IgorMinar requested this change 😛).

That info should be captured on the commit message.

So, I am lacking context (especially given that Δ-prefixed exports are currently [ignored for API docs]) 😟
But the PR LGTM wrt what I suspect is the intention 😁

packages/core/src/render3/instructions/projection.ts Show resolved Hide resolved
tools/ts-api-guardian/test/unit_test.ts Show resolved Hide resolved
tools/ts-api-guardian/test/unit_test.ts
checkThrows(
{'file.d.ts': input},
'file.d.ts(3,7): error: Required jsdoc tags - One of the tags: "@stable", "@foo", "@bar" - must exist on `param`.',
{paramTags: {requireAtLeastOne: ['stable', 'foo', 'bar']}});
});
});
Copy link
Member

Choose a reason for hiding this comment

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

It would be good to also have tests with multiple requireAtLeastOne tags and:
a. one of them being matched
b. all of them being matched

mhevery
mhevery approved these changes Apr 11, 2019
View reviewed changes
Copy link
Contributor

@mhevery mhevery left a comment

Choose a reason for hiding this comment

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

Please address other people's comments LGTM otherwise

ocombe
ocombe approved these changes Apr 11, 2019
View reviewed changes
Copy link
Contributor

@ocombe ocombe left a comment

Choose a reason for hiding this comment

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

sounds good to me on the i18n part

@IgorMinar IgorMinar added the action: merge The PR is ready for merge by the caretaker label Apr 11, 2019
@ngbot
Copy link

ngbot bot commented Apr 11, 2019

I see that you just added the PR action: merge label, but the following checks are still failing:
    failure status "google3" is failing

If you want your PR to be merged, it has to pass all the CI checks.

If you can't get the PR to a green state due to flakes or broken master, please try rebasing to master and/or restarting the CI job. If that fails and you believe that the issue is not due to your change, please contact the caretaker and ask for help.

@IgorMinar IgorMinar closed this in ddadb8e Apr 11, 2019
@gkalpak
Copy link
Member

gkalpak commented Apr 11, 2019

😞

@IgorMinar
Copy link
Contributor

oops.. I missed that @gkalpak's comments were unresolved. @gkalpak can you please add a "cleanup" label in the future to prevent accidental merges like this?

also @benlesh can you please send a followup PR that will address @gkalpak's unresolved comments? thanks!

benlesh added a commit to benlesh/angular that referenced this pull request Apr 11, 2019
@benlesh
test: add additional test for codeGenApi
cbb6ce0 
Addresses comments made by @gkalpak in angular#29820
@benlesh benlesh mentioned this pull request Apr 11, 2019
Closed
benlesh added a commit to benlesh/angular that referenced this pull request Apr 12, 2019
@benlesh
test: add additional test for codeGenApi
5e48eb2 
Addresses comments made by @gkalpak in angular#29820
alxhub pushed a commit that referenced this pull request Apr 15, 2019
@benlesh @alxhub
test: add additional test for codeGenApi (#29844)
b2962db 
Addresses comments made by @gkalpak in #29820

PR Close #29844
wKoza pushed a commit to wKoza/angular that referenced this pull request Apr 17, 2019
@benlesh @wKoza
refactor(ivy): Update @publicapi to @codeGenApi on ivy instructions (a…
d9c623f 
…ngular#29820)

- Removes `@publicApi` annotation from ivy instructions
- Adds new `@codeGenApi` annotation to ivy instructions
- Updates ts_api_guardian to support the new annotation properly

PR Close angular#29820
wKoza pushed a commit to wKoza/angular that referenced this pull request Apr 17, 2019
@benlesh @wKoza
test: add additional test for codeGenApi (angular#29844)
f8dd6b4 
Addresses comments made by @gkalpak in angular#29820

PR Close angular#29844
@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 14, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@mhevery mhevery mhevery approved these changes

@ocombe ocombe ocombe approved these changes

@gkalpak gkalpak gkalpak approved these changes

Assignees
No one assigned
Labels
action: merge The PR is ready for merge by the caretaker aio: preview cla: yes refactoring Issue that involves refactoring or code-cleanup risk: low target: major This PR is targeted for the next major release
Projects
None yet
Milestone
needsTriage
Development

Successfully merging this pull request may close these issues.

None yet
8 participants
@benlesh @jbogarthyde @mary-poppins @gkalpak @IgorMinar @mhevery @ocombe @googlebot