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

chore: notice for https://github.com/aws/aws-cdk/issues/31845 #651

Merged
merged 2 commits into from
Oct 23, 2024
Merged

chore: notice for https://github.com/aws/aws-cdk/issues/31845 #651

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a63e3dd
chore: notice for https://github.com/aws/aws-cdk/issues/31845
mrgrain Oct 23, 2024
6e7160f
Merge branch 'main' into mrgrain/notice-for-31845
mrgrain Oct 23, 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
23 changes: 11 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +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 |
| `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 |
| 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 Down Expand Up @@ -58,10 +58,9 @@ Example:

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|

| Key | Description | component | example |
| ------------------------ | --------------------------------- | ----------- | ----------------------------------------------------- |
| `{resolve:ENVIRONMENTS}` | List of bootstrapped environments | `bootstrap` | aws://1234567890/us-east-1,aws://1234567890/us-east-2 |

## FAQ

Expand Down
14 changes: 13 additions & 1 deletion data/notices.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,19 @@
{
"notices": [
{
"title": "cli: import fails with with 'S3 error: Access Denied",
"title": "cli: cross-account deployments are failing with error 'Need to perform AWS calls for account'",
"issueNumber": 31845,
"overview": "A new check for the bootstrap version used by a stack was introduced. This check runs with incorrect credentials, causing all cross-account deployments to fail.",
"components": [
{
"name": "cli",
"version": "2.163.0"
}
],
"schemaVersion": "1"
},
{
"title": "cli: import fails with with 'S3 error: Access Denied'",
"issueNumber": 31716,
"overview": "When using cdk import, the command tries to read a template that doesn't exist from the assets bucket.",
"components": [
Expand Down