Skip to content

Deployment guides markers#10068

Open
rosieyohannan wants to merge 15 commits intomainfrom
cursor/DOC-49-deployment-guides-markers-e3e0
Open

Deployment guides markers#10068
rosieyohannan wants to merge 15 commits intomainfrom
cursor/DOC-49-deployment-guides-markers-e3e0

Conversation

@rosieyohannan
Copy link
Contributor

Note

You may find that there are errors for the vale/lint job that are unrelated to your change.
Vale checks the whole file when a change is made so if there are existing issues on the page they will be flagged.
You can ignore lint errors outside your changes and the CircleCI docs team will address them for you.
Vale logs are advisory to help all contributors create content that conforms to our style guide. The vale/lint job will not prevent changes from being published.

Description

Added a new section on "Tracking deployments with deploy markers" to the following 15 deployment guides:

  • deploy-android-applications.adoc
  • deploy-ios-applications.adoc
  • deploy-over-ssh.adoc
  • deploy-service-update-to-aws-ecs.adoc
  • deploy-to-artifactory.adoc
  • deploy-to-aws.adoc
  • deploy-to-azure-container-registry.adoc
  • deploy-to-capistrano.adoc
  • deploy-to-cloud-foundry.adoc
  • deploy-to-firebase.adoc
  • deploy-to-google-cloud-platform.adoc
  • deploy-to-heroku.adoc
  • deploy-to-npm-registry.adoc
  • ecs-ecr.adoc
  • publish-packages-to-packagecloud.adoc

Each guide now includes:

  • An explanation of deploy markers and their benefits (timeline, status, rollback, deploy pipelines).
  • Example configurations demonstrating circleci run release integration.
  • Links to related documentation on configuring deploy markers, rollbacks, and deploy pipelines.

Reasons

These changes address Linear issue DOC-49, which aims to update outdated deployment guides and add missing information on setting up deploy markers. This update provides users with essential guidance on tracking deployments, understanding rollback capabilities, and leveraging deploy pipelines within CircleCI for their specific deployment scenarios.

Content checks

Please follow our style when contributing to CircleCI docs. View our style guide or check out our CONTRIBUTING.md for more information.

Preview your changes:

  • View the Vale linter results, select the ci/circleci: lint job at the bottom of your PR. You will be redirected to the vale/lint job output in CircleCI.
  • Preview your changes, select the ci/circleci: build job at the bottom of your PR and you will be redirected to CircleCI. Select the Artifacts tab and select index.html to open a preview version of the docs site built for your latest commit.

Take a moment to check through the following items when submitting your PR (this is just a guide so will not be relevant for all PRs):

Content structure:

  • Break up walls of text by adding paragraph breaks.
  • Consider if the content could benefit from more structure, such as lists or tables, to make it easier to consume.
  • Consider whether the content would benefit from more subsections (h2-h6 headings) to make it easier to consume.
  • Include relevant backlinks to other CircleCI docs/pages.

Formatting:

  • Keep the title between 20 and 70 characters.
  • Check all headings h1-h6 are in sentence case (only first letter is capitalized).

Linear Issue: DOC-49

Open in Web Open in Cursor 

cursoragent and others added 15 commits March 12, 2026 12:55
- Add comprehensive section on tracking deployments with deploy markers
- Include example configuration showing how to integrate deploy markers
- Add links to configure-deploy-markers, rollback, and deploy pipeline guides
- Explain benefits of using deploy markers for Heroku deployments

Co-authored-by: Rosie Yohannan <rosieyohannan@users.noreply.github.com>
- Add comprehensive section on tracking deployments with deploy markers
- Include example configuration for S3 deployment with deploy markers
- Add links to configure-deploy-markers, rollback, and deploy pipeline guides
- Note that deploy markers work with all AWS services (S3, ECR, ECS, CodeDeploy)

Co-authored-by: Rosie Yohannan <rosieyohannan@users.noreply.github.com>
- Add comprehensive section on tracking deployments with deploy markers
- Include example configuration showing Firebase deploy with deploy markers
- Add links to configure-deploy-markers, rollback, and deploy pipeline guides
- Explain benefits of using deploy markers for Firebase deployments

Co-authored-by: Rosie Yohannan <rosieyohannan@users.noreply.github.com>
- Add comprehensive section on tracking deployments with deploy markers
- Include example configuration for GKE deployment with deploy markers
- Add links to configure-deploy-markers, rollback, and deploy pipeline guides
- Note that deploy markers work with all GCP services (GKE, Cloud Run, App Engine)

Co-authored-by: Rosie Yohannan <rosieyohannan@users.noreply.github.com>
- Add comprehensive section on tracking deployments with deploy markers
- Include example configuration showing Android deployment with deploy markers
- Add links to configure-deploy-markers, rollback, and deploy pipeline guides
- Position before Next steps section for better flow

Co-authored-by: Rosie Yohannan <rosieyohannan@users.noreply.github.com>
- Add comprehensive section on tracking deployments with deploy markers
- Include example configuration for TestFlight deployment with deploy markers
- Add links to configure-deploy-markers, rollback, and deploy pipeline guides
- Note that deploy markers work with App Store Connect, TestFlight, App Center, and TestFairy

Co-authored-by: Rosie Yohannan <rosieyohannan@users.noreply.github.com>
- Add comprehensive section on tracking deployments with deploy markers
- Include example configuration for JFrog/Artifactory deployment with deploy markers
- Add links to configure-deploy-markers, rollback, and deploy pipeline guides
- Position before See also section for better flow

Co-authored-by: Rosie Yohannan <rosieyohannan@users.noreply.github.com>
- Add comprehensive section on tracking deployments with deploy markers
- Include example configuration showing ECS deployment with deploy markers
- Add links to configure-deploy-markers, rollback, and deploy pipeline guides
- Show integration with AWS ECR/ECS orbs

Co-authored-by: Rosie Yohannan <rosieyohannan@users.noreply.github.com>
- Add comprehensive section on tracking deployments with deploy markers
- Include example configuration showing ECS service update with deploy markers
- Add links to configure-deploy-markers, rollback, and deploy pipeline guides
- Position before Next steps section for better flow

Co-authored-by: Rosie Yohannan <rosieyohannan@users.noreply.github.com>
- Add comprehensive section on tracking deployments with deploy markers
- Include example configuration for ACR deployment with deploy markers
- Add links to configure-deploy-markers, rollback, and deploy pipeline guides
- Explain benefits of using deploy markers for Azure deployments

Co-authored-by: Rosie Yohannan <rosieyohannan@users.noreply.github.com>
- Add comprehensive section on tracking deployments with deploy markers
- Include example configuration for Capistrano deployment with deploy markers
- Add links to configure-deploy-markers, rollback, and deploy pipeline guides
- Explain benefits of using deploy markers for Capistrano deployments

Co-authored-by: Rosie Yohannan <rosieyohannan@users.noreply.github.com>
- Add comprehensive section on tracking deployments with deploy markers
- Include example configuration for CF deployment with deploy markers
- Add links to configure-deploy-markers, rollback, and deploy pipeline guides
- Note support for Blue-Green deployment strategies

Co-authored-by: Rosie Yohannan <rosieyohannan@users.noreply.github.com>
- Add comprehensive section on tracking deployments with deploy markers
- Include example configuration for SSH deployment with deploy markers
- Add links to configure-deploy-markers, rollback, and deploy pipeline guides
- Explain benefits of using deploy markers for SSH deployments

Co-authored-by: Rosie Yohannan <rosieyohannan@users.noreply.github.com>
- Add comprehensive section on tracking deployments with deploy markers
- Include example configuration for Packagecloud deployment with deploy markers
- Add links to configure-deploy-markers, rollback, and deploy pipeline guides
- Position before See also section for better flow

Co-authored-by: Rosie Yohannan <rosieyohannan@users.noreply.github.com>
- Add comprehensive section on tracking deployments with deploy markers
- Include example configuration with version extraction from package.json
- Add links to configure-deploy-markers, rollback, and deploy pipeline guides
- Explain benefits of using deploy markers for npm package publications

Co-authored-by: Rosie Yohannan <rosieyohannan@users.noreply.github.com>
@cursor
Copy link

cursor bot commented Mar 12, 2026

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
Learn more about Cursor Agents

@linear
Copy link

linear bot commented Mar 12, 2026

@rosieyohannan rosieyohannan marked this pull request as ready for review March 12, 2026 22:31
@rosieyohannan rosieyohannan requested review from a team as code owners March 12, 2026 22:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants