Managing Release Candidates
This page covers the three actions you can take on a release candidate in codev. Each section includes the exact dialog you will see and what happens after you submit.
Release
Use Release when you want to promote a candidate to an environment (staging, UAT, production).
Steps
Find the release candidate row you want to promote.
Open the actions menu and click Release.
Review the dialog details.
Select the target environment.
Click Request Release.
What the dialog shows
Header
Domain name and release name
Issue target
"This will file an issue in {org}/{repo}"
Target Environment
A selector listing registered environments
Deployment Options
Optional section that can be expanded
Actions
Cancel and Request Release
What happens next
codev creates a release request (tracked as an issue in your repository).
The request enters the approval gate. Designated approvers receive a notification.
You can track the approval status in Flows > Pending Approvals.
Once approved, the pipeline locks the target environment and deploys the release.
After deployment completes, the release appears on the Releases page with the target environment listed in the DEPLOYED TO column.
codev submits the release request. The pipeline handles approval, environment locking, and deployment. Track progress in Flows > Run Status.
Get on Sandbox
Use Get on Sandbox to deploy a candidate for testing without going through the approval gate.
Steps
Find the release candidate row you want to test.
Open the actions menu and click Get on Sandbox.
Choose one or more environments.
Select an Environment Profile (default: DEV).
(Optional) Enable Force Install if you want to reinstall packages even if they are already present.
Click Deploy to Sandbox.
What the dialog shows
Header
Domain name and release name
Environment selector
Multi-select with "Select environments..."
Environment Profile
Dropdown with DEV shown
Force Install
Checkbox: "Reinstall all packages, even if already installed"
Actions
Cancel and Deploy to Sandbox (disabled until an environment is selected)
What happens next
codev sends the deployment request directly to the pipeline — no approval required.
The pipeline deploys the RC packages to the selected sandbox environment(s).
Track deployment progress in Flows > Run Status.
Once complete, the RC row updates its DEPLOYED TO column to include the sandbox environment.
Patch
Use Patch when you need a hotfix branch based on a specific release candidate.
Steps
Find the release candidate row you want to patch.
Open the actions menu and click Patch.
Confirm the Source Branch (default: main).
Click Create Patch Branch.
What the dialog shows
Header
Domain name and release name
Source Branch
Combobox defaulting to main
Branch naming
release-patch-{domain}-{release_name}-{random_suffix}
Actions
Cancel and Create Patch Branch
What happens next
codev creates a new branch in your repository with the naming pattern shown above.
The branch appears as a new tab on the Release Candidates page alongside the
maintab.Developers push hotfix commits to this branch.
When code is merged into the patch branch, the pipeline builds a new RC scoped to that branch.
The patch RC can then be released to environments using the same Release action described above.
RC status lifecycle
Release candidates progress through these statuses:
Active
Available for promotion
Released
Deployed to at least one environment
Superseded
Newer RC exists for the same domain
You can still release a superseded RC when needed. The status is informational, not a hard gate.
Related
Last updated