Merge pull request #7427 from jesp209i/main

CICD Updates to Troubleshooting and API v2 Documentation

Author: eshanrnh

umbraco-cloud/build-and-customize-your-solution/handle-deployments-and-environments/umbraco-cicd/README.md

@@ -20,10 +20,6 @@ Explore the practical benefits of using Umbraco CI/CD Flow for your development
 
 * Umbraco CI/CD Flow allows for greater scalability and flexibility in your deployment process. You can adapt your existing CI/CD pipeline to handle larger projects or more complex workflows without having to overhaul your Umbraco Cloud setup.
 
-{% hint style="info" %}
-Attaching a CI/CD pipeline to a flexible environment is currently not possible. The CI/CD workflow must go through the mainline deployment workflow.
-{% endhint %}
-
 **Centralized Management**
 
 * With Umbraco CI/CD Flow, you can centralize the management of your deployments, tests, and workflows. This makes it easier to monitor, troubleshoot, and optimize your processes, leading to more efficient and reliable deployments. Automating deployment minimizes the risk for human errors that could have a negative effect on the target environment.

umbraco-cloud/build-and-customize-your-solution/handle-deployments-and-environments/umbraco-cicd/troubleshooting.md

@@ -10,6 +10,12 @@ The reason for this is that the KUDU deploy process fails. This process takes th
 
 To resolve this issue, remove the `RestorePackagesWithLockFile` to allow the deployments to go through as expected.
 
+### Deployment reports: No changes detected - cleaning up
+
+The package you uploaded didn't contain any changes that would affect the Git repository on the Cloud Environment. The CI/CD job will skip the remaining steps and complete.
+
+If you expected the deployment to create changes in the Cloud Environment, make sure you are uploading the correct ZIP file.
+
 ## Cloud Sync
 
 ### The projects left-most mainline environment has changed
@@ -163,16 +169,27 @@ In rare cases deployments fail, and the cloud infrastructure doesn't clean up co
 
 In order to fix this issue, you need to use [KUDU](../../../optimize-and-maintain-your-site/monitor-and-troubleshoot/power-tools/) to remove the leftover marker file.
 
-1. Access KUDU on the "left-most" environment
+1. Access KUDU on the affected environment
 
 * If you only have one environment you want the live environment
-* If you have more than one environment, you want the left-most mainline environment
+* If you use V1 endpoints and have more than one environment, you want the left-most mainline environment
 
 3. Navigate to `site` > `locks` folder In there, there should be a file named `updating`
 4. Remove the `updating` file.
 
 Once the marker file is removed, run your pipeline again.
 
+### Unable to verify Deployment has finished
+
+This error will be shown when the system is unable to verify that the latest deployment has been pushed and deployed in Kudu.
+When a change is pushed to a Cloud Environment the Kudu deployment is started. CI/CD is also utilizing this flow.
+
+A couple of steps to try:
+- Make sure your code can compile and run (relevant only if you have enabled the `skipBuildAndRestore` toggle in V2)
+- Running npm commands via `.csproj` files is generally unsupported on Umbraco Cloud
+- Create and commit a small change and try deploying again
+  - A small change can be adding a dummy text file next to your code files or adding a comment in a `.cs` file.
+
 ## Environment errors after deployment
 
 ### Unable to determine environment by its {environment-id}

umbraco-cloud/build-and-customize-your-solution/handle-deployments-and-environments/umbraco-cicd/umbracocloudapi.md

@@ -277,15 +277,18 @@ Should the deployment fail, check the `deploymentStatusMessages` for more inform
   ],
   "createdUtc": string,
   "completedUtc":string,
-  "modifiedUtc": string
+  "modifiedUtc": string,
+  "cloudRepositoryUpdated": boolean
 }
 ```
 
 ## Query Deployments and fetch Changes
 
 ### Get Deployments
 
-The endpoint lets you retrieve a list of completed deployments. It can only list deployments that have been run through the api.
+The endpoint retrieves a list of deployments that have created a change in the Git repository of the cloud environment. A deployment can have the state **Completed** or **Failed**.
+
+It only lists deployments that have been run through the API.
 
 The API allows you to filter and limit the number of returned deployments using query parameters:
 
@@ -327,6 +330,7 @@ The response from this API call will return an object containing a list of deplo
         "createdUtc": string,
         "modifiedUtc": string,
         "completedUtc": string,
+        "cloudRepositoryUpdated": boolean
       }
     ],
   "totalItems": number,