Skip to content

chore(pkglint): update language for experimental constructs. #6500

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
Merged
mergify merged 8 commits into from
Mar 2, 2020
Merged

chore(pkglint): update language for experimental constructs. #6500

mergify merged 8 commits into from
Mar 2, 2020

Conversation

@nija-at
Copy link
Contributor

@nija-at nija-at commented Feb 28, 2020

The current language states that the entire module is unstable and
should not be used in production.

This is not entirely correct. The updated language differentiates CFN
resources from higher level APIs, and states the former can be used in
production and are stable, while the latter APIs are not stable and
subject to change.

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

chore(pkglint): update language for experimental constructs.
8cbccb8 
The current language states that the entire module is unstable and
should not be used in production.

This is not entirely correct. The updated language differentiates CFN
resources from higher level APIs, and states the former can be used in
production and are stable, while the latter APIs are not stable and
subject to change.
@nija-at nija-at added the contribution/core This is a PR that came from AWS. label Feb 28, 2020
@nija-at nija-at requested review from ccfife and rix0rrr February 28, 2020 10:26
@nija-at nija-at self-assigned this Feb 28, 2020
@nija-at nija-at added the pr/do-not-merge This PR should not be merged at this time. label Feb 28, 2020
@aws-cdk-automation
Copy link
Collaborator

aws-cdk-automation commented Feb 28, 2020

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
  • Commit ID: 8cbccb8
  • Result: FAILED
  • Build Logs (available for 30 days)

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

@nija-at
Copy link
Contributor Author

nija-at commented Feb 28, 2020

I've clearly missed the correct set of changes needed to get this to work. At the moment, use this PR to review the content of what should go into the README of an experimental module.

I'll update this PR with the correct set of changes.

rix0rrr
rix0rrr reviewed Feb 28, 2020
View reviewed changes
@aws-cdk-automation
Copy link
Collaborator

aws-cdk-automation commented Feb 28, 2020

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
  • Commit ID: e853e48
  • Result: FAILED
  • Build Logs (available for 30 days)

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

eladb
eladb reviewed Feb 28, 2020
View reviewed changes
@nija-at
tweak the L1 line
c0457be 
Co-Authored-By: Elad Ben-Israel <[email protected]>
@aws-cdk-automation
Copy link
Collaborator

aws-cdk-automation commented Feb 28, 2020

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
  • Commit ID: c0457be
  • Result: FAILED
  • Build Logs (available for 30 days)

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

ccfife
ccfife approved these changes Feb 28, 2020
View reviewed changes
Copy link
Contributor

@ccfife ccfife left a comment

Choose a reason for hiding this comment

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

This is a definite improvement, is accurate, and reads way less scary.

@aws-cdk-automation
Copy link
Collaborator

aws-cdk-automation commented Mar 2, 2020

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
  • Commit ID: 60b608e
  • Result: FAILED
  • Build Logs (available for 30 days)

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

@aws-cdk-automation
Copy link
Collaborator

aws-cdk-automation commented Mar 2, 2020

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
  • Commit ID: 842ebd7
  • Result: FAILED
  • Build Logs (available for 30 days)

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

@aws-cdk-automation
Copy link
Collaborator

aws-cdk-automation commented Mar 2, 2020

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
  • Commit ID: 5a95440
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@nija-at nija-at removed the pr/do-not-merge This PR should not be merged at this time. label Mar 2, 2020
@mergify
Copy link
Contributor

mergify bot commented Mar 2, 2020

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

1 similar comment
@mergify
Copy link
Contributor

mergify bot commented Mar 2, 2020

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 Mar 2, 2020

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 25952a9 into master Mar 2, 2020
@mergify mergify bot deleted the nija-at/pkglint-experimental-banner branch March 2, 2020 17:29
@aws-cdk-automation
Copy link
Collaborator

aws-cdk-automation commented Mar 2, 2020

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
  • Commit ID: 78be9d9
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@andrestone andrestone mentioned this pull request Mar 6, 2020
Merged
eladb pushed a commit that referenced this pull request Mar 9, 2020
@nija-at @mergify
chore(pkglint): update language for experimental constructs. (#6500)
f2fe68f 
* chore(pkglint): update language for experimental constructs.

The current language states that the entire module is unstable and
should not be used in production.

This is not entirely correct. The updated language differentiates CFN
resources from higher level APIs, and states the former can be used in
production and are stable, while the latter APIs are not stable and
subject to change.

* add a sentence around intent

* tweak the L1 line

Co-Authored-By: Elad Ben-Israel <[email protected]>

* slight tweak

* run pkglint -f and fixed up create-missing-libraries.ts

* revert unintended monocdk changes

Co-authored-by: Elad Ben-Israel <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rix0rrr rix0rrr rix0rrr approved these changes

+2 more reviewers

@eladb eladb eladb approved these changes

@ccfife ccfife ccfife approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@nija-at nija-at

Labels

contribution/core This is a PR that came from AWS.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@nija-at @aws-cdk-automation @rix0rrr @eladb @ccfife