Skip to content

chore(ubergen): create missing L1 READMEs and strip stability banners#16692

Merged
njlynch merged 3 commits intomasterfrom
njlynch/ubergenreadme
Oct 12, 2021
Merged

chore(ubergen): create missing L1 READMEs and strip stability banners#16692
njlynch merged 3 commits intomasterfrom
njlynch/ubergenreadme

Conversation

@njlynch
Copy link
Copy Markdown
Contributor

@njlynch njlynch commented Sep 28, 2021

This change bundles together two changes for how ubergen handles package
READMEs. The first is to generate a base README for experimental/alpha modules
where only the L1s are included. The second is to strip out the stability
banners from all READMEs; this is because, by definition, everything included
in aws-cdk-lib is stable, so the banners are now redundant/misleading.

fixes #16567


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

@njlynch njlynch added this to the [GA] CDK V2 milestone Sep 28, 2021
@njlynch njlynch requested a review from a team September 28, 2021 15:57
@njlynch njlynch self-assigned this Sep 28, 2021
@gitpod-io
Copy link
Copy Markdown

gitpod-io bot commented Sep 28, 2021

@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Sep 28, 2021
@njlynch njlynch force-pushed the njlynch/ubergenreadme branch from b4bd706 to b714e65 Compare September 29, 2021 13:05
This change bundles together two changes for how ubergen handles package
READMEs. The first is to generate a base README for experimental/alpha modules
where only the L1s are included. The second is to strip out the stability
banners from *all* READMEs; this is because, by definition, everything included
in aws-cdk-lib is stable, so the banners are now redundant/misleading.

fixes #16567
@njlynch njlynch force-pushed the njlynch/ubergenreadme branch from abb46d2 to 35cba00 Compare October 11, 2021 14:30
@njlynch njlynch requested review from a team and rix0rrr October 11, 2021 14:32
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Oct 12, 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
Copy Markdown
Collaborator

AWS CodeBuild CI Report

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

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

@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Oct 12, 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).

@njlynch njlynch closed this Oct 12, 2021
@njlynch njlynch reopened this Oct 12, 2021
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Oct 12, 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).

@njlynch njlynch merged commit 0499641 into master Oct 12, 2021
@njlynch njlynch deleted the njlynch/ubergenreadme branch October 12, 2021 09:36
TikiTDO pushed a commit to TikiTDO/aws-cdk that referenced this pull request Feb 21, 2022
…aws#16692)

This change bundles together two changes for how ubergen handles package
READMEs. The first is to generate a base README for experimental/alpha modules
where only the L1s are included. The second is to strip out the stability
banners from *all* READMEs; this is because, by definition, everything included
in aws-cdk-lib is stable, so the banners are now redundant/misleading.

fixes aws#16567
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.

[CDKv2GA]: READMEs for alpha modules

3 participants