diff --git a/README.md b/README.md index 7f99b3d..557bb51 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,14 @@ command, or it can be used by a GitHub workflow to update issues. 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 | -| `components` | A list of the components affected by the incident | See table below | -| `schemaVersion` | The version of the schema used for this notice | String | +| 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 | +| `severity` | The severity of the notice. Warnings are printer yellow. Errors are printed red. Default is no color | 'warning' or 'error' | +| `components` | A list of the components affected by the incident | See table below | +| `schemaVersion` | The version of the schema used for this notice | String | Component structure: @@ -33,6 +34,8 @@ Component structure: 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 'bootstrap'. This will match against the bootstrap stack version in each + environment `cdk deploy` runs against. These will only be displayed when running `cdk deploy`. [semver]: https://www.npmjs.com/package/semver @@ -51,6 +54,15 @@ Example: } ``` +## Dynamic Values + +Some notices can include special strings that dynamically resolve to values during CLI execution. + +| Key | Description | component | example | +| ----------------------------| ---------------------------------- | --------------------------------- |------------------------------------------------------| +| `{resolve:ENVIRONMENTS}` | List of bootstrapped environments | `bootstrap` | aws://1234567890/us-east-1,aws://1234567890/us-east-2| + + ## FAQ When adding a new notice to `notices.json`, if you see errors like `Invalid fully qualified name`