fix: ignore staging property changes (#4413)

Author: adrians5j

packages/pulumi-aws/src/apps/api/ApiCloudfront.ts

@@ -123,6 +123,21 @@ export const ApiCloudfront = createAppModule({
                 viewerCertificate: {
                     cloudfrontDefaultCertificate: true
                 }
+            },
+            opts: {
+                // We are ignoring changes to the "staging" property. This is because of the following.
+                // With the 5.41.0 release of Webiny, we also upgraded Pulumi to v6. This introduced a change
+                // with how Cloudfront distributions are deployed, where Pulumi now also controls the new
+                // `staging` property.
+                // If not set, Pulumi will default it to `false`. Which is fine, but, the problem is
+                // that, because this property did not exist before, it will always be considered as a change
+                // upon deployment.
+                // We might think this is fine, but, the problem is that a change in this property causes
+                // a full replacement of the Cloudfront distribution, which is not acceptable. Especially
+                // if a custom domain has already been associated with the distribution. This then would
+                // require the user to disassociate the domain, wait for the distribution to be replaced,
+                // and then re-associate the domain. This is not a good experience.
+                ignoreChanges: ["staging"]
             }
         });
     }

packages/pulumi-aws/src/apps/react/createReactPulumiApp.ts

@@ -109,6 +109,21 @@ export const createReactPulumiApp = (projectAppParams: CreateReactPulumiAppParam
                     viewerCertificate: {
                         cloudfrontDefaultCertificate: true
                     }
+                },
+                opts: {
+                    // We are ignoring changes to the "staging" property. This is because of the following.
+                    // With the 5.41.0 release of Webiny, we also upgraded Pulumi to v6. This introduced a change
+                    // with how Cloudfront distributions are deployed, where Pulumi now also controls the new
+                    // `staging` property.
+                    // If not set, Pulumi will default it to `false`. Which is fine, but, the problem is
+                    // that, because this property did not exist before, it will always be considered as a change
+                    // upon deployment.
+                    // We might think this is fine, but, the problem is that a change in this property causes
+                    // a full replacement of the Cloudfront distribution, which is not acceptable. Especially
+                    // if a custom domain has already been associated with the distribution. This then would
+                    // require the user to disassociate the domain, wait for the distribution to be replaced,
+                    // and then re-associate the domain. This is not a good experience.
+                    ignoreChanges: ["staging"]
                 }
             });
 

packages/pulumi-aws/src/apps/website/createWebsitePulumiApp.ts

@@ -122,6 +122,21 @@ export const createWebsitePulumiApp = (projectAppParams: CreateWebsitePulumiAppP
                     viewerCertificate: {
                         cloudfrontDefaultCertificate: true
                     }
+                },
+                opts: {
+                    // We are ignoring changes to the "staging" property. This is because of the following.
+                    // With the 5.41.0 release of Webiny, we also upgraded Pulumi to v6. This introduced a change
+                    // with how Cloudfront distributions are deployed, where Pulumi now also controls the new
+                    // `staging` property.
+                    // If not set, Pulumi will default it to `false`. Which is fine, but, the problem is
+                    // that, because this property did not exist before, it will always be considered as a change
+                    // upon deployment.
+                    // We might think this is fine, but, the problem is that a change in this property causes
+                    // a full replacement of the Cloudfront distribution, which is not acceptable. Especially
+                    // if a custom domain has already been associated with the distribution. This then would
+                    // require the user to disassociate the domain, wait for the distribution to be replaced,
+                    // and then re-associate the domain. This is not a good experience.
+                    ignoreChanges: ["staging"]
                 }
             });
 
@@ -204,6 +219,10 @@ export const createWebsitePulumiApp = (projectAppParams: CreateWebsitePulumiAppP
                     viewerCertificate: {
                         cloudfrontDefaultCertificate: true
                     }
+                },
+                opts: {
+                    // Check the comment in the `appCloudfront` resource above for more info.
+                    ignoreChanges: ["staging"]
                 }
             });