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

integ-runner: What should be the message: "If these destructive changes are necessary, please indicate this on the PR" #29636

Closed
caevv opened this issue Mar 28, 2024 · 5 comments
Labels
@aws-cdk/integ-runner closed-for-staleness This issue was automatically closed because it hadn't received any attention in a while. documentation This is a problem with documentation. effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days.

Comments

@caevv
Copy link

caevv commented Mar 28, 2024

Describe the issue

What should the PR contain to pass through this error?

!!! This test contains destructive changes !!!
    Stack: aws-cdk-lambda-1 - Resource: MyLambdaServiceRole4539ECB6 - Impact: WILL_DESTROY
    Stack: aws-cdk-lambda-1 - Resource: AliasAliasPermissionAF30F9E8 - Impact: WILL_REPLACE
    Stack: aws-cdk-lambda-1 - Resource: AliasFunctionUrlDC6EC566 - Impact: WILL_REPLACE
    Stack: aws-cdk-lambda-1 - Resource: Aliasinvokefunctionurl4CA9917B - Impact: WILL_REPLACE
!!! If these destructive changes are necessary, please indicate this on the PR !!!

Links

https://github.com/aws/aws-cdk/tree/69cff2eda84dacfe265d518fc88ccf55930f59c4/packages/%40aws-cdk/integ-runner#update-workflow

@caevv caevv added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Mar 28, 2024
@msambol
Copy link
Contributor

msambol commented Mar 29, 2024

@caevv Have you opened the PR yet? Can you link it?

@tim-finnigan tim-finnigan self-assigned this Apr 2, 2024
@tim-finnigan tim-finnigan added investigating This issue is being investigated and/or work is in progress to resolve the issue. and removed needs-triage This issue or PR still needs to be triaged. labels Apr 2, 2024
@tim-finnigan
Copy link

The Update Workflow section you linked also notes:

By default, integration tests are run with the "update workflow" enabled. This can be disabled by using the --disable-update-workflow command line option

If an existing snapshot is being updated, the integration test runner will first deploy the existing snapshot and then perform a stack update with the new changes. This is to test for cases where an update would cause a breaking change only on a stack update.

That being said, maybe further clarification is needed on this part regarding the format/content of what the indication message should have:

If the destructive changes are expected (and required) then please indicate this on your PR.

@tim-finnigan tim-finnigan added p2 feature-request A feature should be added or improved. effort/small Small work item – less than a day of effort and removed investigating This issue is being investigated and/or work is in progress to resolve the issue. labels Apr 2, 2024
@tim-finnigan tim-finnigan removed their assignment Apr 2, 2024
@pahud pahud added the response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days. label Jun 3, 2024
Copy link

github-actions bot commented Jun 3, 2024

This issue has not received a response in a while. If you want to keep this issue open, please leave a comment below and auto-close will be canceled.

@github-actions github-actions bot added closing-soon This issue will automatically close in 4 days unless further comments are made. closed-for-staleness This issue was automatically closed because it hadn't received any attention in a while. and removed closing-soon This issue will automatically close in 4 days unless further comments are made. labels Jun 3, 2024
@github-actions github-actions bot closed this as completed Jun 9, 2024
@scanlonp
Copy link
Contributor

Hey @caevv, you can call it out in the PR body such as,

Destructive changes in the integ test: in integ.lambda.test.js, there were destructive changes on these resrouces: Lambda1, Lambda2. This is necessary because ... (the important reason).

Seeing that warning is often an indication that the code change is breaking and likely not the correct approach. If it is necessary, it should bejustified.

As reviewers, we want to be aware of potential breaking behavior. Calling out destructive changes alerts us to this possibility and let's us handle the code change with more care than normal. Still, there are cases where these changes are valid, which is why this text exists.

Hope this answers your question!

@caevv
Copy link
Author

caevv commented Jun 12, 2024

I'm just asking for clarification on what is needed here:

If the destructive changes are expected (and required) then please indicate this on your PR.

I managed to look into the repo and find that you need to add an allowDestroy flag.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/integ-runner closed-for-staleness This issue was automatically closed because it hadn't received any attention in a while. documentation This is a problem with documentation. effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days.
Projects
None yet
Development

No branches or pull requests

5 participants