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

chore: remove all @experimental annotation #14071

Merged
merged 6 commits into from
Apr 20, 2021
Merged

chore: remove all @experimental annotation #14071

merged 6 commits into from
Apr 20, 2021

Conversation

NetaNir
Copy link
Contributor

@NetaNir NetaNir commented Apr 9, 2021

As a part of v2 efforts we are stabilizing all @experimental APIs from stable modules. A separate PR #14070, adds a lint rule that ban the usage of @experimental.

Note on experimental modules

The removal of the @experimental annotation from APIs in experimental modules does not change their stability, as it determined only by their containing module stability.


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@gitpod-io
Copy link

gitpod-io bot commented Apr 9, 2021

@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Apr 9, 2021
@NetaNir NetaNir force-pushed the neta/remove-exp-2 branch from fc7beb0 to bcde084 Compare April 9, 2021 07:22
@@ -869,7 +867,6 @@ export class CfnAuthorizerV2 extends cdk.CfnResource implements cdk.IInspectable
*
* @param inspector - tree inspector to collect and process attributes
*
* @stability experimental
*/
public inspect(inspector: cdk.TreeInspector) {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@nija-at any idea what's this about? Why is this method in a non .generated file?

Copy link
Contributor

Choose a reason for hiding this comment

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

see commit description - d58667e

@NetaNir NetaNir requested review from a team and nija-at April 9, 2021 08:25
@nija-at nija-at added the pr/do-not-merge This PR should not be merged at this time. label Apr 9, 2021
Copy link
Contributor

@nija-at nija-at left a comment

Choose a reason for hiding this comment

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

added do-not-merge, to give time for any objections in their modules.

@skinny85
Copy link
Contributor

skinny85 commented Apr 9, 2021

If you could wait for #13780 and #14009 before merging this one, I would appreciate it!

Copy link
Contributor

@eladb eladb left a comment

Choose a reason for hiding this comment

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

LGTM, please revert the CLI changes. Added 'do-not-merge' to allow others to review.

@@ -6,7 +6,6 @@ export enum Mode {
}

/**
* @experimental
Copy link
Contributor

Choose a reason for hiding this comment

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

@rix0rrr @NetaNir which APIs exactly are we exporting from the CDK CLI? Are we really ready to call these stable? I am concerned that this will signal to folks that they can use the CLI as a library and will bound is to this APIs... I'd hold off with removing the @experimental tags here (the CLI is also not part of the aws-cdk-lib, so I don't think this is required for v2)

Copy link
Contributor Author

@NetaNir NetaNir Apr 15, 2021

Choose a reason for hiding this comment

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

@eladb But it is a part of the AWS CDK, and I don't think there will be any notable distinction in our v2 announcements between the CLI and the framework, at least not in a way that will be easy for customers to understand. If we break a public API in the CLI post v2 GA, it will most likely be perceived as not keeping our stability promise. In all honesty, I don't think this annotation was ever understood/noticed by customers.

Copy link
Contributor

Choose a reason for hiding this comment

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

@eladb - we should just remove all exports from the package index so that this package cannot be used as a library.
(need to confirm if npm/node allows this)

That feels like the correct solution here, no?

@@ -522,7 +522,6 @@ export class ConstructNode {
* Remove the child with the given name, if present.
*
* @returns Whether a child with the given name was deleted.
* @experimental
Copy link
Contributor

Choose a reason for hiding this comment

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

Since some files do not exist in v2-main (like this one), this will result in some merge conflicts. @NetaNir can you please make sure to do a forward merge to v2-main immediately after this is merged so that conflicts will be limited to this change and not intermingled with lots of future changes? (copy @nija-at)

@NetaNir NetaNir removed the pr/do-not-merge This PR should not be merged at this time. label Apr 20, 2021
@mergify
Copy link
Contributor

mergify bot commented Apr 20, 2021

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify
Copy link
Contributor

mergify bot commented Apr 20, 2021

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
  • Commit ID: 00854fe
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify
Copy link
Contributor

mergify bot commented Apr 20, 2021

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit d4a1c28 into master Apr 20, 2021
@mergify mergify bot deleted the neta/remove-exp-2 branch April 20, 2021 23:55
mergify bot pushed a commit that referenced this pull request Apr 21, 2021
Add a lint rule that disallow the use of @experimental in stable module. Ideally we would do the same for experimental modules, but for these, jsii marks all properties as experimental. Since we only care about stable modules, this is sufficient. Im open to other suggestion as well. 

Should only be merged after #14071 which removes all experimental API.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
john-tipper pushed a commit to john-tipper/aws-cdk that referenced this pull request May 10, 2021
As a part of v2 efforts we are stabilizing all `@experimental` APIs from stable modules.  A separate PR aws#14070, adds a lint rule that ban the usage of @experimental.

#### Note on experimental modules
The removal of the @experimental annotation from APIs in experimental modules does not change their stability, as it determined only by their containing module stability.  

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
john-tipper pushed a commit to john-tipper/aws-cdk that referenced this pull request May 10, 2021
Add a lint rule that disallow the use of @experimental in stable module. Ideally we would do the same for experimental modules, but for these, jsii marks all properties as experimental. Since we only care about stable modules, this is sufficient. Im open to other suggestion as well. 

Should only be merged after aws#14071 which removes all experimental API.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
hollanddd pushed a commit to hollanddd/aws-cdk that referenced this pull request Aug 26, 2021
As a part of v2 efforts we are stabilizing all `@experimental` APIs from stable modules.  A separate PR aws#14070, adds a lint rule that ban the usage of @experimental.

#### Note on experimental modules
The removal of the @experimental annotation from APIs in experimental modules does not change their stability, as it determined only by their containing module stability.  

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
hollanddd pushed a commit to hollanddd/aws-cdk that referenced this pull request Aug 26, 2021
Add a lint rule that disallow the use of @experimental in stable module. Ideally we would do the same for experimental modules, but for these, jsii marks all properties as experimental. Since we only care about stable modules, this is sufficient. Im open to other suggestion as well. 

Should only be merged after aws#14071 which removes all experimental API.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants