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(service-catalog): allow Product Stack to override analytics reporting and stack descriptions #31985

Merged
merged 5 commits into from
Nov 7, 2024

Conversation

GavinZZ
Copy link
Contributor

@GavinZZ GavinZZ commented Nov 1, 2024

Issue # (if applicable)

Closes #31924

Reason for this change

Product Stack cannot override analytics reporting and descriptions. Support these two props.

Description of changes

The reason I didn't choose to allow ProductStackProps to extend StackProps and instead manually add these two properties are because all of the other properties, i.e. stackName, env, notificationArns, terminationProtection, crossRegionReferences, permissionsBoundary, suppressTemplateIndentation, do not mutate the stack template but are used by CDK CLI. These properties have no impact on the Product Stack template generated and thus I did not include them.

Description of how you validated changes

Unit and integ tests added.

Checklist


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@github-actions github-actions bot added effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2 labels Nov 1, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team November 1, 2024 20:55
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Nov 1, 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.

@GavinZZ GavinZZ changed the title feat(service-catalog): allow Product Stack to override analytics reporting and stack descriptions chore(service-catalog): allow Product Stack to override analytics reporting and stack descriptions Nov 1, 2024
@GavinZZ GavinZZ marked this pull request as ready for review November 1, 2024 21:25
@aws-cdk-automation aws-cdk-automation dismissed their stale review November 1, 2024 21:27

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Nov 2, 2024
Copy link
Contributor

@paulhcsun paulhcsun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small docstring change. I think this should be a feat instead of a chore as well.

@paulhcsun paulhcsun changed the title chore(service-catalog): allow Product Stack to override analytics reporting and stack descriptions feat(service-catalog): allow Product Stack to override analytics reporting and stack descriptions Nov 7, 2024
@paulhcsun
Copy link
Contributor

@Mergifyio update

Copy link
Contributor

mergify bot commented Nov 7, 2024

update

☑️ Nothing to do

  • #commits-behind > 0 [📌 update requirement]
  • -closed [📌 update requirement]
  • -conflict [📌 update requirement]
  • queue-position = -1 [📌 update requirement]

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 removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Nov 7, 2024
@paulhcsun paulhcsun added the pr-linter/exempt-readme The PR linter will not require README changes label Nov 7, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review November 7, 2024 21:30

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

Copy link
Contributor

mergify bot commented Nov 7, 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).

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@mergify mergify bot merged commit d8ad02a into main Nov 7, 2024
12 checks passed
@mergify mergify bot deleted the yuanhaoz/product-stack-props-update branch November 7, 2024 22:26
Copy link
Contributor

mergify bot commented Nov 7, 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).

Copy link

github-actions bot commented Nov 7, 2024

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 Nov 7, 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. effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2 pr-linter/exempt-readme The PR linter will not require README changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ProductStackProps should extend StackProps
3 participants