Skip to content

Commit dbe6234

Browse files
authored
Merge pull request #1904 from menakaj/PE
Add release management concepts
2 parents d83118a + 7848cde commit dbe6234

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Release Management
2+
3+
Release management is the process of managing, planning, scheduling and controlling a software build through different stages and environments; it includes testing and deploying software releases.
4+
5+
## Release
6+
7+
A Release represents a uniquely identifiable, environment-independent bundle of runtime artifacts and configurations created when a build is first deployed.
8+
9+
## Release Deployment
10+
11+
A Release Deployment represents a Release deployed to a specific environment with environment-dependent configuration. A given release can be deployed multiple times to the same or different environments, and each deployment produces a distinct release deployment due to differences in environment configuration.
12+
13+
## Release Naming Convention
14+
15+
A structured naming format (`<date>-<release number>.<config-revision>.<deployment-count>`, e.g., 20250404-1.1.1) is being used for maintaining clarity and consistency across different environments.
16+
17+
Ex: 20260319-1.1.1
18+
19+
- Date: Calendar date on which the Release is created (format YYYYMMDD, default UTC timezone).
20+
- Counter: Sequential counter indicating how many Releases were created on the same Date
21+
- Configuration revision: Version identifier of the environment‑specific configuration snapshot applied to the deployment.
22+
- Deployment number: Counter that increments each time the same deployment is deployed (or re‑deployed) to a specific environment.
23+
24+
The `<date>-<release number>` (which is identified as the release) will not be changed during promotion, allowing clear identification of the release being deployed in all environments.

en/developer-docs/mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ nav:
102102
- Environments: choreo-concepts/environments.md
103103
- WSO2 Developer Platform Marketplace: choreo-concepts/choreo-marketplace.md
104104
- Access Control: choreo-concepts/access-control.md
105+
- Release Management: choreo-concepts/release-management.md
105106
- Develop Components:
106107
- Develop Services:
107108
- Service Component Overview: develop-components/develop-services/service-component-overview.md
@@ -387,6 +388,7 @@ plugins:
387388
"consume/manage-subscription.md": "https://wso2.com/choreo/docs/consuming-services/manage-subscription/"
388389
"consume/test-api.md": "https://wso2.com/choreo/docs/testing/test-rest-endpoints-via-the-openapi-console/"
389390
"marketplace.md": "https://wso2.com/choreo/docs/choreo-concepts/choreo-marketplace/"
391+
"release-management.md": "https://wso2.com/choreo/docs/choreo-concepts/release-management/"
390392
"observe-and-analyze/observe/observability-overview.md": "https://wso2.com/choreo/docs/monitoring-and-insights/observability-overview/"
391393
"observe-and-analyze/observe/root-cause-analysis.md": "https://wso2.com/choreo/docs"
392394
"observe-and-analyze/analyze/view-api-insights.md": "https://wso2.com/choreo/docs/monitoring-and-insights/view-api-insights/"

0 commit comments

Comments
 (0)