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.

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

Merged
merged 30 commits into from
Sep 30, 2024
Merged

Conversation

iliapolo
Copy link
Contributor

@iliapolo iliapolo commented Sep 25, 2024

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:

  1. Bubble up the bootstrap stack version all the up to the CLI entry-point, where notices are initialized.
  2. Allow access to notices from anywhere in our CLI code base.

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 new Notices singleton class. It is instantiated in the CLI entry-point (via Notices.create with user configuration), and can then be accessed from anywhere in the code (via Notices.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

@aws-cdk-automation aws-cdk-automation requested a review from a team September 25, 2024 12:19
@github-actions github-actions bot added the p2 label Sep 25, 2024
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Sep 25, 2024
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a 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.

@aws-cdk-automation aws-cdk-automation added the pr/needs-cli-test-run This PR needs CLI tests run against it. label Sep 25, 2024
@aws-cdk-automation aws-cdk-automation removed the pr/needs-cli-test-run This PR needs CLI tests run against it. label Sep 29, 2024
@iliapolo iliapolo added the pr/do-not-merge This PR should not be merged at this time. label Sep 29, 2024
@iliapolo
Copy link
Contributor Author

Not merging - need to verify this doesn't break multi region deployments.

@iliapolo iliapolo removed the pr-linter/exempt-readme The PR linter will not require README changes label Sep 30, 2024
@iliapolo iliapolo dismissed otaviomacedo’s stale review September 30, 2024 06:25

Significant changes since last review

@iliapolo iliapolo added pr/do-not-merge This PR should not be merged at this time. and removed pr/do-not-merge This PR should not be merged at this time. labels Sep 30, 2024
@aws-cdk-automation
Copy link
Collaborator

➡️ PR build request submitted to test-main-pipeline ⬅️

A maintainer must now check the pipeline and add the pr-linter/cli-integ-tested label once the pipeline succeeds.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: e3ad0cd
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Sep 30, 2024
@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Sep 30, 2024
@iliapolo iliapolo removed the pr/do-not-merge This PR should not be merged at this time. label Sep 30, 2024
Copy link
Contributor

mergify bot commented Sep 30, 2024

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).

@mergify mergify bot merged commit b0e4a54 into main Sep 30, 2024
37 checks passed
@mergify mergify bot deleted the epolon/notices-on-bootstrap-version branch September 30, 2024 09:05
Copy link

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 30, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
contribution/core This is a PR that came from AWS. p2 pr-linter/cli-integ-tested Assert that any CLI changes have been integ tested pr-linter/exempt-integ-test The PR linter will not require integ test changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants