Add deploy markers configuration#97
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Snapshot WarningsEnsure that dependencies are being submitted on PR branches and consider enabling retry-on-snapshot-warnings. See the documentation for more information and troubleshooting advice. Scanned FilesNone |
Review Summary by QodoAdd CircleCI Deploy Markers configuration to deployment job
WalkthroughsDescription• Add deployment planning step using CircleCI release plan command • Implement deployment status tracking with running, success, failed states • Integrate CircleCI Deploy Markers for automated deployment visibility • Configure environment and component metadata for deployment tracking Diagramflowchart LR
checkout["Checkout code"]
plan["Plan deployment<br/>circleci run release plan"]
deploy["Deploy step"]
running["Update status<br/>to RUNNING"]
success["Update status<br/>to SUCCESS<br/>on_success"]
failed["Update status<br/>to FAILED<br/>on_fail"]
checkout --> plan
plan --> deploy
deploy --> running
running --> success
running --> failed
File Changes1. .circleci/config.yml
|
Code Review by Qodo
1. RUNNING set after deploy
|
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughSummary by CodeRabbitNo user-facing changes in this release. Internal deployment process improvements have been implemented to enhance reliability and status tracking during the release workflow. WalkthroughThe Changes
Sequence Diagram(s)sequenceDiagram
participant CircleCI as CircleCI CI/CD
participant ReleaseOrch as Release Orchestrator
participant DeployAction as Deploy Action
participant StatusService as Status Service
CircleCI->>ReleaseOrch: Plan deployment with target version
ReleaseOrch-->>CircleCI: Plan ready
CircleCI->>StatusService: Update release status to RUNNING
StatusService-->>CircleCI: Status updated
CircleCI->>DeployAction: Execute deployment
alt Deployment Succeeds
DeployAction-->>CircleCI: Success
CircleCI->>StatusService: Update release status to SUCCESS
else Deployment Fails
DeployAction-->>CircleCI: Failure
CircleCI->>StatusService: Update release status to FAILED
end
StatusService-->>CircleCI: Status confirmed
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
 |
|
Overall Grade |
Security Reliability Complexity Hygiene |
Code Review Summary
| Analyzer | Status | Updated (UTC) | Details |
|---|---|---|---|
| Scala |  |
Apr 5, 2026 10:06a.m. | Review ↗ |
| Swift | |
Apr 5, 2026 10:06a.m. | Review ↗ |
| JavaScript | |
Apr 5, 2026 10:06a.m. | Review ↗ |
| Ruby | |
Apr 5, 2026 10:06a.m. | Review ↗ |
| C & C++ | |
Apr 5, 2026 10:06a.m. | Review ↗ |
| C# | |
Apr 5, 2026 10:06a.m. | Review ↗ |
| Rust | |
Apr 5, 2026 10:06a.m. | Review ↗ |
| Shell | |
Apr 5, 2026 10:06a.m. | Review ↗ |
| Terraform | |
Apr 5, 2026 10:06a.m. | Review ↗ |
| Test coverage |  |
Apr 5, 2026 10:06a.m. | Review ↗ |
| SQL | |
Apr 5, 2026 10:06a.m. | Review ↗ |
| Secrets | |
Apr 5, 2026 10:06a.m. | Review ↗ |
| Ansible | |
Apr 5, 2026 10:06a.m. | Review ↗ |
|
![qodo-code-review[bot]](https://avatars.githubusercontent.com/in/484649?s=60&v=4){kind=small}
Comment on lines
27
to
+33
| - run: | ||
| name: "Deploy step" | ||
| command: echo "Deploying project..." | ||
| - run: | ||
| name: Update deployment status to running | ||
| command: circleci run release update "${CIRCLE_JOB}" --status=RUNNING | ||
| - run: |
There was a problem hiding this comment.
1. Running set after deploy 🐞 Bug ≡ Correctness
In the deploy job, the Deploy Marker is updated to RUNNING only after the deploy command executes, so the recorded deployment start/status is wrong and RUNNING is never emitted when the deploy step fails. This breaks the accuracy of deployment visibility and duration metrics.
Agent Prompt
## Issue description
The deploy marker status is set to RUNNING after the deployment command, which makes the lifecycle tracking inaccurate and skips RUNNING on deployment failures.
## Issue Context
The current order is: plan -> deploy -> update RUNNING -> update SUCCESS/FAILED.
## Fix Focus Areas
- .circleci/config.yml[20-40]
## Suggested change
Move the "Update deployment status to running" step to immediately after "Plan deployment" and before the "Deploy step" so RUNNING reflects the actual start of deployment.
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
Comment on lines
+23
to
+39
| circleci run release plan "${CIRCLE_JOB}" \ | ||
| --environment-name="default" \ | ||
| --component-name="${CIRCLE_PROJECT_REPONAME}" \ | ||
| --target-version="1.0.${CIRCLE_BUILD_NUM}-${CIRCLE_SHA1:0:7}" | ||
| - run: | ||
| name: "Deploy step" | ||
| command: echo "Deploying project..." | ||
| - run: | ||
| name: Update deployment status to running | ||
| command: circleci run release update "${CIRCLE_JOB}" --status=RUNNING | ||
| - run: | ||
| name: Update deployment status to success | ||
| command: circleci run release update "${CIRCLE_JOB}" --status=SUCCESS | ||
| when: on_success | ||
| - run: | ||
| name: Update deployment status to failed | ||
| command: circleci run release update "${CIRCLE_JOB}" --status=FAILED |
There was a problem hiding this comment.
2. Non-unique deployment id 🐞 Bug ≡ Correctness
All Deploy Marker plan/update commands use ${CIRCLE_JOB} as the deployment identifier, which
resolves to the constant job name "deploy" in this config. Multiple pipeline runs can overwrite each
other’s deployment records by updating the same id.
Agent Prompt
## Issue description
Using `${CIRCLE_JOB}` as the deploy marker identifier makes the id static (`deploy`), so different pipeline runs can update the same deployment record.
## Issue Context
The identifier passed as the first argument to both `circleci run release plan` and `circleci run release update` must be stable within a single run, but unique across runs.
## Fix Focus Areas
- .circleci/config.yml[20-40]
## Suggested change
Replace `${CIRCLE_JOB}` with a per-run unique id (while keeping it consistent across plan/update), for example:
- `${CIRCLE_WORKFLOW_ID}-${CIRCLE_JOB}`
- or `${CIRCLE_PIPELINE_ID}-${CIRCLE_JOB}`
Update all plan/update commands to use the same new identifier.
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
Comment on lines
+30
to
+40
| - run: | ||
| name: Update deployment status to running | ||
| command: circleci run release update "${CIRCLE_JOB}" --status=RUNNING | ||
| - run: | ||
| name: Update deployment status to success | ||
| command: circleci run release update "${CIRCLE_JOB}" --status=SUCCESS | ||
| when: on_success | ||
| - run: | ||
| name: Update deployment status to failed | ||
| command: circleci run release update "${CIRCLE_JOB}" --status=FAILED | ||
| when: on_fail |
There was a problem hiding this comment.
3. Marker updates fail deploy 🐞 Bug ☼ Reliability
The marker update steps run circleci run release update ... without guarding failures, so transient tracking call failures can fail the deploy job even if the deployment succeeded. The on_fail marker step can also fail and obscure the original deployment failure.
Agent Prompt
## Issue description
Deploy marker reporting commands can fail for reasons unrelated to deployment (network/auth/transient), but currently they can fail the entire job.
## Issue Context
Marker steps are auxiliary telemetry; deployment success/failure should be driven by the actual deploy command.
## Fix Focus Areas
- .circleci/config.yml[30-40]
## Suggested change
Wrap marker commands so they do not fail the job, e.g.:
- `circleci run release update ... --status=RUNNING || echo 'Deploy marker update failed'`
Optionally add a small retry loop for the marker calls, and ensure the FAILED marker step also cannot fail the job (so it doesn’t mask the real failure).
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
Comment on lines
+30
to
+32
| - run: | ||
| name: Update deployment status to running | ||
| command: circleci run release update "${CIRCLE_JOB}" --status=RUNNING |
There was a problem hiding this comment.
Bug: The deployment status update step lacks when: always, so it won't run if the preceding deployment step fails, leading to incomplete deployment tracking.
Severity: MEDIUM
Suggested Fix
Add the when: always condition to the "Update deployment status to running" step. This ensures that the deployment status is updated regardless of whether the preceding deployment step succeeds or fails, providing more robust and accurate deployment tracking.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: .circleci/config.yml#L30-L32
Potential issue: The CircleCI configuration places the "Update deployment status to
running" step after the deployment step. However, this status update step is missing the
`when: always` condition. While the current placeholder deployment command (`echo
"Deploying project..."`) will not fail, this configuration establishes a flawed pattern.
When a real, fallible deployment command replaces the placeholder, any failure in that
command will prevent the status update step from running. This will result in incomplete
deployment tracking.
Did we get this right? 👍 / 👎 to inform future reviews.
Up to standards ✅🟢 Issues
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds Deploy Markers to your CircleCI configuration. Deploy Markers enable CircleCI to automatically track when deployments happen in your pipelines, giving you:
Learn more about Deploy Markers in our documentation.