diff --git a/README.md b/README.md index c8085d5..7e9652a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -## AWS CDK Notices +# AWS CDK Notices A static website for the distribution of [notices][1] that we want to broadcast to AWS CDK users. This information can be used in different ways. For @@ -6,10 +6,11 @@ example, it can be consumed by the CDK CLI to display messages to users on every command, or it can be used by a GitHub workflow to update issues. ## Structure + Notices are declared as JSON objects with the following structure: | Field | Description | Format | -|:----------------|:------------------------------------------------------------|-----------------| +| :-------------- | :---------------------------------------------------------- | --------------- | | `title` | The title of the incident (max length: 100) | Free form text | | `issueNumber` | The ID of the GitHub issue where we are tracking this event | Number | | `overview` | A paragraph with more information about the incident | Free form text | @@ -19,22 +20,23 @@ Notices are declared as JSON objects with the following structure: Component structure: | Field | Description | Format | -|-----------|------------------------------------|----------------------------| +| --------- | ---------------------------------- | -------------------------- | | `name` | The name of the affected component | StringĀ¹ | | `version` | The version range affected | [Semantic version][semver] | 1: The name can be either: + * A fully qualified name of a construct (e.g., `aws-cdk-lib.aws_amplify.CfnBranch`) -* A prefix of a fully qualified name (e.g., `aws-cdk-lib.aws_amplify.`). +* A prefix of a fully qualified name (e.g., `aws-cdk-lib.aws_amplify.`). This will match a constructs with this prefix. Note the `.` at the end. -* The reserved word `cli`. This will match against the CDK CLI fetching +* The reserved word `cli`. This will match against the CDK CLI fetching the notices from the website. -* The reserved word `framework`. This will match against the - `@aws-cdk/core`, in case of v1 or `aws-cdk-lib` in case of v2. +* The reserved word `framework`. This will match against the + `@aws-cdk/core`, in case of v1 or `aws-cdk-lib` in case of v2. [semver]: https://www.npmjs.com/package/semver -Example: +Example: ```json { @@ -53,4 +55,4 @@ Example: This project is licensed under the Apache-2.0 License. -[1]: https://cli.cdk.dev-tools.aws.dev/notices.json \ No newline at end of file +[1]: https://cli.cdk.dev-tools.aws.dev/notices.json diff --git a/data/notices.json b/data/notices.json index 4531eb4..e1a2a62 100644 --- a/data/notices.json +++ b/data/notices.json @@ -1,13 +1,17 @@ { "notices": [ { - "title": "custom resources: provisioning failures", - "issueNumber": 26325, - "overview": "Custom resources may fail to deploy / destroy ", + "title": "core: Stack crossRegionReferences and CfnJson fail with 'Error: Cannot find module '../dist/core/.generated'", + "issueNumber": 28465, + "overview": "Enabling the experimental crossRegionReferences on a Stack or using the core.CfnJson construct causes app synthesis to fail 'Error: Cannot find module '../dist/core/.generated' because the files are missing from the faulty release.", "components": [ { - "name": "aws-cdk-lib.core.CustomResource", - "version": ">=v2.87.0