Conversation
Signed-off-by: Rayhan Hossain <rhossain@microsoft.com>
There was a problem hiding this comment.
Pull request overview
Adds written release strategy and a step-by-step release runbook for the DocumentDB Kubernetes Operator, to standardize versioning, cadence, support expectations, and the mechanics of cutting/publishing releases.
Changes:
- Introduces a release strategy/design document (versioning, cadence, support window, compatibility matrix).
- Adds a RELEASE.md runbook describing the automated release-agent flow and a manual fallback.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/designs/release-strategy.md | Defines release cadence/versioning/support policy + compatibility and process links |
| RELEASE.md | Provides operational release instructions (agent-driven and manual) |
| - Clear support windows for production deployments | ||
| - Backward compatibility within minor versions | ||
| - Roll-forward strategy for bug and security fixes | ||
|
|
There was a problem hiding this comment.
Easy to identify which versions of underlying components are used
| | Stage | Version Pattern | Description | | ||
| |-------|-----------------|-------------| | ||
| | Preview | `0.x.x` | API may change, not recommended for production | | ||
| | GA (General Availability) | `1.x.x+` | Stable API, production-ready | |
There was a problem hiding this comment.
-
instead of GA we should say stable
-
How are we dealing with the documentdb side of things. Are we supporting only stable documentdb verson? Or are we supporting the latest and greatest? Please eleborate on.
-
What abour CNPG? I assume we only do stable versions but again - probably good to elaborate on
| | Release Type | Frequency | Description | | ||
| |--------------|-----------|-------------| | ||
| | **Minor Release** | Every 3 months | New features, enhancements | | ||
| | **Patch Release** | As needed | Bug fixes, security patches | |
|
|
||
| | Version | Target Date | Feature Freeze | | ||
| |---------|-------------|----------------| | ||
| | v0.2.0 | ~ Mar 2026 | Feb 2026 | |
There was a problem hiding this comment.
we should align with the major MS conferences or kubecon or?
| ### What "Support" Means | ||
|
|
||
| **Technical Support:** | ||
| - Community support via [GitHub Discussions](https://github.com/documentdb/documentdb-kubernetes-operator/discussions) |
There was a problem hiding this comment.
also add Discord chat to this
| |------------------|------------|----------------------|--------------------| | ||
| | v0.1.x | 16.x | 1.x | 1.x | | ||
|
|
||
| > **Note:** The operator bundles compatible versions of PostgreSQL, the DocumentDB Postgres extension (`pg_documentdb`), and the DocumentDB Gateway. Image tags follow the format `<postgres-version>-v<extension-version>` (e.g., `16.3-v1.3.0`). |
There was a problem hiding this comment.
our goal is image catalog eventually
| | Architecture | Supported | | ||
| |--------------|-----------| | ||
| | linux/amd64 | ✅ | | ||
| | linux/arm64 | ✅ | |
There was a problem hiding this comment.
We shoudl add a note that we will support other architectures (e.g. power) based on cimmunity interest
|
|
||
| 1. Reading current version from `operator/documentdb-helm-chart/Chart.yaml` | ||
| 2. Bumping version numbers | ||
| 3. Generating changelog entries from git commits |
There was a problem hiding this comment.
we shoudl use a tool - people are peddlign stuff like https://gitsaga.io but I guess if we agree ona. structre (see https://docs.openstack.org/reno/latest/) and have the AI extract and deal with it - migth be sufficient
2 participants
No description provided.