chore: stripping stability banners for Cfn constructs on alpha modules #17327
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
njlynch
reviewed
Nov 4, 2021
Yes, pkglint enforces an additional rule for it because it has a |
madeline-k
approved these changes
Nov 4, 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 CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
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 bot
pushed a commit
that referenced
this pull request
Nov 7, 2021
In #17327, we stripped away the stability banner for `Cfn` resources from README's of alpha modules, since these modules don't actually contain L1 resources. Problem is that this stripping causes a bunch of `pkglint` violations on the `v2-main` branch, for example: ```console @aws-cdk/aws-iot-alpha: In package package.json -- 972 | @aws-cdk/aws-iot-alpha: - [package-info/maturity] Missing stability banner for experimental in README.md file (fixable) 973 | @aws-cdk/aws-iot-alpha: Error: Some package.json files had errors 974 | @aws-cdk/aws-iot-alpha: at main (/codebuild/output/src115445882/src/github.com/aws/aws-cdk/tools/@aws-cdk/pkglint/bin/pkglint.js:30:15) 975 | @aws-cdk/aws-iot-alpha: at Object.<anonym ``` This PR fixes the transform and makes the necessary changes so that `pkglint` will be happy. Note that this was not detected during merge of #17327 into master since on master, these packages are transformed into private packages, and hence are not validated. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
TikiTDO
pushed a commit
to TikiTDO/aws-cdk
that referenced
this pull request
Feb 21, 2022
In aws#17327, we stripped away the stability banner for `Cfn` resources from README's of alpha modules, since these modules don't actually contain L1 resources. Problem is that this stripping causes a bunch of `pkglint` violations on the `v2-main` branch, for example: ```console @aws-cdk/aws-iot-alpha: In package package.json -- 972 | @aws-cdk/aws-iot-alpha: - [package-info/maturity] Missing stability banner for experimental in README.md file (fixable) 973 | @aws-cdk/aws-iot-alpha: Error: Some package.json files had errors 974 | @aws-cdk/aws-iot-alpha: at main (/codebuild/output/src115445882/src/github.com/aws/aws-cdk/tools/@aws-cdk/pkglint/bin/pkglint.js:30:15) 975 | @aws-cdk/aws-iot-alpha: at Object.<anonym ``` This PR fixes the transform and makes the necessary changes so that `pkglint` will be happy. Note that this was not detected during merge of aws#17327 into master since on master, these packages are transformed into private packages, and hence are not validated. ---- *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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Alpha modules don't have Cfn constructs, so it doesn't make sense to have a stability banner for them on the README.
Fixes #17038.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license