-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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.
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
feat(cli): notices on bootstrap version #31555
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.
A comment requesting an exemption should contain the text Exemption Request
. Additionally, if clarification is needed add Clarification Request
to a comment.
Not merging - need to verify this doesn't break multi region deployments. |
Significant changes since last review
➡️ PR build request submitted to A maintainer must now check the pipeline and add the |
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 main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
Comments on closed issues and PRs are hard for our team to see. |
Reason for this change
We would like to be able to send customers a notice when issues with bootstrap templates are discovered.
Description of changes
Currently, our notices mechanism can only match against CLI/Framework versions. In order to match against a bootstrap stack version, we need to hook into the deploy process, where we already perform bootstrap version checks.
There were two options to implement the change:
I opted for number 2 because it is less disruptive (in terms of files changed) and more flexible for future code that might want to take advantage of the notices mechanism.
The tricky thing is, notices are dependent on user configuration (i.e
Configuration
), which we don't have access to in this part of the code. To make it work, I created a newNotices
singleton class. It is instantiated in the CLI entry-point (viaNotices.create
with user configuration), and can then be accessed from anywhere in the code (viaNotices.get()
).This change resulted in a pretty big refactor to the notices code, but keeps everything else untouched.
Docs
Documentation of enhanced notice authoring capabilities: cdklabs/aws-cdk-notices#631
Description of how you validated changes
Added unit tests.
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license