Skip to content
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

feat: notices on bootstrap version #631

Merged
merged 4 commits into from
Sep 30, 2024
Merged

feat: notices on bootstrap version #631

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3decd13
Update README.md
iliapolo Sep 30, 2024
2659d3d
Update README.md
iliapolo Sep 30, 2024
be9c713
Update README.md
iliapolo Sep 30, 2024
9aceb4a
Fixed typo
otaviomacedo Sep 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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

Expand All @@ -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`
Expand Down