Deployment guides markers

docs/guides/modules/deploy/pages/deploy-android-applications.adoc

@@ -360,6 +360,76 @@ run: sudo gem install fastlane
 +
 Then, replace the `run: fastlane playstore` step with `run: bundle exec fastlane playstore`.
 
+[#track-deployments-with-deploy-markers]
+== Track your deployments with deploy markers
+
+After setting up your Android app deployment to the Google Play Store, you can add deploy markers to track and manage your deployments in the CircleCI web app. Deploy markers provide visibility into your deployment history and enable rollback capabilities.
+
+[#what-are-deploy-markers]
+=== What are deploy markers
+
+Deploy markers are a lightweight way to log your deployments in CircleCI. When you add deploy markers to your configuration, you can:
+
+* View a timeline of all deployments in the CircleCI web app
+* Track deployment status (pending, running, success, or failed)
+* Roll back to previous versions using rollback pipelines
+* Trigger deployments directly from the CircleCI web app using deploy pipelines
+
+[#add-deploy-markers-to-your-android-deployment]
+=== Add deploy markers to your Android deployment
+
+To add deploy markers to your Android deployment job, add the `circleci run release` commands to your deployment workflow. The following example shows a basic deployment marker setup:
+
+[source,yaml]
+----
+jobs:
+  deploy:
+    docker:
+      - image: cimg/android:2024.11.1
+    resource_class: large
+    steps:
+      - checkout
+      - run:
+          name: Plan deployment
+          command: |
+            circleci run release plan android-playstore-deploy \
+              --target-version="${versionMajor}.${versionMinor}.${versionPatch}" \
+              --environment-name="production" \
+              --component-name="my-android-app"
+      - android/decode_keystore:
+          keystore_location: android/app/keystore
+      - android/create_keystore_properties:
+          working_directory: android
+      - android/create_google_play_key:
+          working_directory: android
+      - android/fastlane_deploy:
+          working_directory: android
+          lane_name: playstore
+      - run:
+          name: Update deployment status
+          command: circleci run release update android-playstore-deploy --status=running
+      - run:
+          name: Update deployment to SUCCESS
+          command: circleci run release update android-playstore-deploy --status=SUCCESS
+          when: on_success
+      - run:
+          name: Update deployment to FAILED
+          command: circleci run release update android-playstore-deploy --status=FAILED
+          when: on_fail
+----
+
+For complete instructions on configuring deploy markers, including status updates and advanced options, refer to the xref:configure-deploy-markers.adoc[Configure Deploy Markers] guide.
+
+[#set-up-rollback-and-deploy-pipelines]
+=== Set up rollback and deploy pipelines
+
+Once you have deploy markers configured, you can set up rollback and deploy pipelines to manage your Android app deployments directly from the CircleCI web app:
+
+* xref:set-up-rollbacks.adoc[Set up a Rollback Pipeline] - Configure a pipeline to roll back to previous versions of your Android application
+* xref:set-up-deploys.adoc[Set up a Deploy Pipeline] - Configure a pipeline to deploy new versions from the CircleCI web app
+
+These features provide additional control and visibility for your Android deployments to the Google Play Store.
+
 [#next-steps]
 == Next steps
 

docs/guides/modules/deploy/pages/deploy-ios-applications.adoc

@@ -423,3 +423,66 @@ desc "Upload to TestFairy"
   end
 end
 ----
+
+[#track-deployments-with-deploy-markers]
+== Track your deployments with deploy markers
+
+After setting up your iOS app deployment, you can add deploy markers to track and manage your deployments in the CircleCI web app. Deploy markers work with all iOS distribution methods including App Store Connect, TestFlight, Visual Studio App Center, and TestFairy.
+
+[#what-are-deploy-markers]
+=== What are deploy markers
+
+Deploy markers are a lightweight way to log your deployments in CircleCI. When you add deploy markers to your configuration, you can:
+
+* View a timeline of all deployments in the CircleCI web app
+* Track deployment status (pending, running, success, or failed)
+* Roll back to previous versions using rollback pipelines
+* Trigger deployments directly from the CircleCI web app using deploy pipelines
+
+[#add-deploy-markers-to-your-ios-deployment]
+=== Add deploy markers to your iOS deployment
+
+To add deploy markers to your iOS deployment job, add the `circleci run release` commands to your deployment workflow. The following example shows a basic deployment marker setup for a TestFlight deployment:
+
+[source,yaml]
+----
+jobs:
+  build-and-deploy:
+    macos:
+      xcode: 15.0.0
+    steps:
+      - checkout
+      - run:
+          name: Plan deployment
+          command: |
+            circleci run release plan ios-testflight-deploy \
+              --target-version="${CIRCLE_BUILD_NUM}" \
+              --environment-name="testflight" \
+              --component-name="my-ios-app"
+      - run:
+          name: Fastlane deploy
+          command: bundle exec fastlane beta
+      - run:
+          name: Update deployment status
+          command: circleci run release update ios-testflight-deploy --status=running
+      - run:
+          name: Update deployment to SUCCESS
+          command: circleci run release update ios-testflight-deploy --status=SUCCESS
+          when: on_success
+      - run:
+          name: Update deployment to FAILED
+          command: circleci run release update ios-testflight-deploy --status=FAILED
+          when: on_fail
+----
+
+For complete instructions on configuring deploy markers, including status updates and advanced options, refer to the xref:configure-deploy-markers.adoc[Configure Deploy Markers] guide.
+
+[#set-up-rollback-and-deploy-pipelines]
+=== Set up rollback and deploy pipelines
+
+Once you have deploy markers configured, you can set up rollback and deploy pipelines to manage your iOS app deployments directly from the CircleCI web app:
+
+* xref:set-up-rollbacks.adoc[Set up a Rollback Pipeline] - Configure a pipeline to roll back to previous versions of your iOS application
+* xref:set-up-deploys.adoc[Set up a Deploy Pipeline] - Configure a pipeline to deploy new versions from the CircleCI web app
+
+These features provide additional control and visibility for your iOS deployments across all distribution platforms.

docs/guides/modules/deploy/pages/deploy-over-ssh.adoc

@@ -64,3 +64,67 @@ workflows:
             branches:
               only: main # only deploy on the main branch
 ```
+
+[#track-deployments-with-deploy-markers]
+== Track your deployments with deploy markers
+
+After setting up your SSH deployment, you can add deploy markers to track and manage your deployments in the CircleCI web app. Deploy markers provide visibility into your deployment history and enable rollback capabilities.
+
+[#what-are-deploy-markers]
+=== What are deploy markers
+
+Deploy markers are a lightweight way to log your deployments in CircleCI. When you add deploy markers to your configuration, you can:
+
+* View a timeline of all deployments in the CircleCI web app
+* Track deployment status (pending, running, success, or failed)
+* Roll back to previous versions using rollback pipelines
+* Trigger deployments directly from the CircleCI web app using deploy pipelines
+
+[#add-deploy-markers-to-your-ssh-deployment]
+=== Add deploy markers to your SSH deployment
+
+To add deploy markers to your SSH deployment job, add the `circleci run release` commands to your deployment workflow. The following example shows a basic deployment marker setup:
+
+[source,yaml]
+----
+jobs:
+  deploy:
+    machine:
+      image: ubuntu-2204:2023.07.2
+    steps:
+      - checkout
+      - run:
+          name: Plan deployment
+          command: |
+            circleci run release plan ssh-deploy \
+              --target-version="${CIRCLE_SHA1:0:7}" \
+              --environment-name="production" \
+              --component-name="my-app"
+      - run:
+          name: Deploy Over SSH
+          command: |
+            ssh $SSH_USER@$SSH_HOST "<remote deploy command>"
+      - run:
+          name: Update deployment status
+          command: circleci run release update ssh-deploy --status=running
+      - run:
+          name: Update deployment to SUCCESS
+          command: circleci run release update ssh-deploy --status=SUCCESS
+          when: on_success
+      - run:
+          name: Update deployment to FAILED
+          command: circleci run release update ssh-deploy --status=FAILED
+          when: on_fail
+----
+
+For complete instructions on configuring deploy markers, including status updates and advanced options, refer to the xref:configure-deploy-markers.adoc[Configure Deploy Markers] guide.
+
+[#set-up-rollback-and-deploy-pipelines]
+=== Set up rollback and deploy pipelines
+
+Once you have deploy markers configured, you can set up rollback and deploy pipelines to manage your SSH deployments directly from the CircleCI web app:
+
+* xref:set-up-rollbacks.adoc[Set up a Rollback Pipeline] - Configure a pipeline to roll back to previous versions of your application
+* xref:set-up-deploys.adoc[Set up a Deploy Pipeline] - Configure a pipeline to deploy new versions from the CircleCI web app
+
+These features provide additional control and visibility for your SSH deployments.

docs/guides/modules/deploy/pages/deploy-service-update-to-aws-ecs.adoc

@@ -211,6 +211,86 @@ workflows:
             - aws-ecs/deploy_service_update
 ----
 
+[#track-deployments-with-deploy-markers]
+== Track your deployments with deploy markers
+
+After setting up your AWS ECS service updates, you can add deploy markers to track and manage your deployments in the CircleCI web app. Deploy markers provide visibility into your deployment history and enable rollback capabilities.
+
+[#what-are-deploy-markers]
+=== What are deploy markers
+
+Deploy markers are a lightweight way to log your deployments in CircleCI. When you add deploy markers to your configuration, you can:
+
+* View a timeline of all deployments in the CircleCI web app
+* Track deployment status (pending, running, success, or failed)
+* Roll back to previous versions using rollback pipelines
+* Trigger deployments directly from the CircleCI web app using deploy pipelines
+
+[#add-deploy-markers-to-your-ecs-deployment]
+=== Add deploy markers to your ECS deployment
+
+To add deploy markers to your AWS ECS deployment job, you can create a custom job that wraps the deploy_service_update orb job with deploy marker commands. The following example shows how to integrate deploy markers:
+
+[source,yaml]
+----
+jobs:
+  deploy-with-markers:
+    executor: aws-cli/default
+    steps:
+      - run:
+          name: Plan deployment
+          command: |
+            circleci run release plan ecs-service-deploy \
+              --target-version="${CIRCLE_SHA1}" \
+              --environment-name="production" \
+              --component-name="${MY_APP_PREFIX}-service"
+      - aws-cli/setup:
+          role_arn: arn:aws:iam::123456789012
+      - aws-ecs/deploy_service_update:
+          family: '${MY_APP_PREFIX}-service'
+          cluster: '${MY_APP_PREFIX}-cluster'
+          container_image_name_updates: 'container=${MY_APP_PREFIX}-service,tag=${CIRCLE_SHA1}'
+      - run:
+          name: Update deployment status
+          command: circleci run release update ecs-service-deploy --status=running
+      - run:
+          name: Update deployment to SUCCESS
+          command: circleci run release update ecs-service-deploy --status=SUCCESS
+          when: on_success
+      - run:
+          name: Update deployment to FAILED
+          command: circleci run release update ecs-service-deploy --status=FAILED
+          when: on_fail
+
+workflows:
+  build-and-deploy:
+    jobs:
+      - aws-ecr/build_and_push_image:
+          repo: '${MY_APP_PREFIX}'
+          tag: '${CIRCLE_SHA1}'
+          auth:
+            - aws-cli/setup:
+                role_arn: arn:aws:iam::123456789012
+      - deploy-with-markers:
+          requires:
+            - aws-ecr/build_and_push_image
+      - verify-deployment:
+          requires:
+            - deploy-with-markers
+----
+
+For complete instructions on configuring deploy markers, including status updates and advanced options, refer to the xref:configure-deploy-markers.adoc[Configure Deploy Markers] guide.
+
+[#set-up-rollback-and-deploy-pipelines]
+=== Set up rollback and deploy pipelines
+
+Once you have deploy markers configured, you can set up rollback and deploy pipelines to manage your AWS ECS deployments directly from the CircleCI web app:
+
+* xref:set-up-rollbacks.adoc[Set up a Rollback Pipeline] - Configure a pipeline to roll back to previous versions of your ECS service
+* xref:set-up-deploys.adoc[Set up a Deploy Pipeline] - Configure a pipeline to deploy new versions from the CircleCI web app
+
+These features provide additional control and visibility for your AWS ECS service deployments.
+
 [#next-steps]
 == Next steps
 

docs/guides/modules/deploy/pages/deploy-to-artifactory.adoc

@@ -139,6 +139,90 @@ workflows:
           context: artifactory
 ----
 
+[#track-deployments-with-deploy-markers]
+== Track your deployments with deploy markers
+
+After setting up your Artifactory deployment, you can add deploy markers to track and manage your artifact uploads in the CircleCI web app. Deploy markers provide visibility into your deployment history and enable rollback capabilities.
+
+[#what-are-deploy-markers]
+=== What are deploy markers
+
+Deploy markers are a lightweight way to log your deployments in CircleCI. When you add deploy markers to your configuration, you can:
+
+* View a timeline of all deployments in the CircleCI web app
+* Track deployment status (pending, running, success, or failed)
+* Roll back to previous versions using rollback pipelines
+* Trigger deployments directly from the CircleCI web app using deploy pipelines
+
+[#add-deploy-markers-to-your-artifactory-deployment]
+=== Add deploy markers to your Artifactory deployment
+
+To add deploy markers to your Artifactory deployment job, add the `circleci run release` commands to your deployment workflow. The following example shows a basic deployment marker setup:
+
+[source,yaml]
+----
+jobs:
+  create-build-package:
+    docker:
+      - image: cimg/openjdk:17.0.10
+    working_directory: ~/repo
+    steps:
+      - checkout
+      - run:
+          name: Plan deployment
+          command: |
+            circleci run release plan artifactory-deploy \
+              --target-version="${CIRCLE_SHA1:0:7}" \
+              --environment-name="production" \
+              --component-name="my-artifact"
+      - run:
+          name: Install JFrog CLI
+          command: curl -fL https://getcli.jfrog.io/v2-jf | sh
+      - run:
+          name: Configure JFrog Creds
+          command: |
+            ./jf c add <server_id> \
+              --artifactory-url $ARTIFACTORY_URL \
+              --user $ARTIFACTORY_USER \
+              --password $ARTIFACTORY_APIKEY \
+              --interactive=false
+      - run:
+          name: Maven Build and Deploy
+          command: |
+            ./jf mvnc \
+              --server-id-resolve <server_id> \
+              --server-id-deploy <server_id> \
+              --repo-resolve-releases libs-release \
+              --repo-resolve-snapshots libs-snapshot \
+              --repo-deploy-releases release-candidates \
+              --repo-deploy-snapshots snapshots \
+              --include-patterns "*.jar, *.pom, *.xml"
+            ./jf mvn clean install
+      - run:
+          name: Update deployment status
+          command: circleci run release update artifactory-deploy --status=running
+      - run:
+          name: Update deployment to SUCCESS
+          command: circleci run release update artifactory-deploy --status=SUCCESS
+          when: on_success
+      - run:
+          name: Update deployment to FAILED
+          command: circleci run release update artifactory-deploy --status=FAILED
+          when: on_fail
+----
+
+For complete instructions on configuring deploy markers, including status updates and advanced options, refer to the xref:configure-deploy-markers.adoc[Configure Deploy Markers] guide.
+
+[#set-up-rollback-and-deploy-pipelines]
+=== Set up rollback and deploy pipelines
+
+Once you have deploy markers configured, you can set up rollback and deploy pipelines to manage your Artifactory deployments directly from the CircleCI web app:
+
+* xref:set-up-rollbacks.adoc[Set up a Rollback Pipeline] - Configure a pipeline to roll back to previous versions of your artifacts
+* xref:set-up-deploys.adoc[Set up a Deploy Pipeline] - Configure a pipeline to deploy new versions from the CircleCI web app
+
+These features provide additional control and visibility for your Artifactory deployments.
+
 [#see-also]
 == See also