Compile a list of information to display on a release dashboard
Context
As a first step to &1124 (closed), we should investigate and list what information the first iteration/PoC release dashboard should contain, so that we can look for where to find and create the metrics on #19985 (closed)
This issue will serve as a converging point (SSOT) for that information that is scattered on issues and comments such as:
- Proposal: Increase the GitLab release visibilit... (#19410 - closed)
- Discussion: How can we make it easier to guaran... (#19321 - closed)
- &1124 (comment 1733231093)
- #19321 (comment 1425632512)
To distinguish the list from the discussions in comments, let's compile the list on the issue description.
Exit Criteria
-
A list of information/data wanted on the first iteration of the release dashboard is compiled -
Get feedback from teamDelivery-Releases and finalize the filtered priority list -
We have sufficient information to start working on finding/creating the metrics to display this data #19985 (closed)
Compiled List
This list is the compilation of all the ideas from various issues/epics mentioned above. This list has been filtered down in the "Priority List" section.
Full list of ideas
- Current Release Status
- Is the next planned release for monthly or planned?
- When is the next planned release?
- When is the next monthly release?
- Reference to the upcoming planned release schedule
- Link for dates of monthly and planned releases (outcome of #19972 (closed))
- Monthly Release
- Is the monthly release open? (example visualization below)
- Open (green): Engineers can create MRs, and any commit that reached production is expected to be released with the next monthly release.
- Warning (yellow): Signal the RC tagging date is getting closer (implementation idea #19988 (comment 1769312991))
- In-Progress (red): Final RC has been tagged, any commit that has not reached production prior to the tagging time is not included in the monthly release. This will reset to green after the minor version is released
- Upcoming monthly/minor release date
- Last commit in tagged RC
- Reference to the chatops command (e.g.
/chatops run release check <MR link> <milestone version>
) - Current status "pipeline" view (example visualization below)
- RC Tagged -> Minor version tagged -> Deployed to the release environment
- Grey for not started (e.g. "Awaiting RC tag")
- Blue for in-progress (e.g. "Tagging RC")
- Green for complete (e.g. "RC Tagged")
- Start/Finish(publish) can be inferred by the release date
- RC Tagged -> Minor version tagged -> Deployed to the release environment
- Total number of new commits in the release
- Link to the active release's task issue
- Is the monthly release open? (example visualization below)
- Planned Release
- Is the planned release open? (green-red status)
- Open (green): Engineers can create security MRs, tag the issues with security-target, and expect the issues to be included in the upcoming planned release.
- In-Progress (red): Planned release is in progress, which means that security issues without security-target label and their associated MRs cannot be included in the upcoming planned release.
- Upcoming planned release date
- Release versions supported by the GitLab maintenance policy (e.g. 16.8, 16.7, 16.6)
- Hyperlink to https://docs.gitlab.com/ee/policy/maintenance.html
- Release versions for upcoming planned release (e.g. 16.8.1, 16.7.4, 16.6.6)
- Link to the security release tracking issue (https://gitlab.com/gitlab-org/gitlab/-/issues), not set if there isn't one open
- List of included issues, either
- Link to the security issues comment with the table (e.g. https://gitlab.com/gitlab-org/gitlab/-/issues/438105#note_1724428990), or
- Directly presenting on grafana (is this possible?)
- List of included issues, either
- Link to the release security patch release issue (https://gitlab.com/gitlab-org/release/tasks/-/issues), not set if there isn't one open
- Deadline to get linked security issues ready (bot assigned to MRs, issue labeled with security-target, and linked to the security issue)
- Current status pipeline view (example visualization below)
- Default branch MRs merge -> backport/stable branches MRs merge -> Versions tag
- Grey for not started (e.g. "Awaiting default branch merge")
- Blue for in-progress (e.g. "Merging default branch MRs")
- Green for complete (e.g. "Default branch MRs merged")
- Default branch MRs merge -> backport/stable branches MRs merge -> Versions tag
- Total number of new commits in the release
- Is the planned release open? (green-red status)
Priority List
The following are prioritized for the first iterations of the dashboard:
- Link for dates of monthly and planned releases
- Monthly Release
- Next version and release date (example visualization)
- Is the monthly release open? (example visualization below)
- Open (green): Engineers can create MRs, and any commit that reached production is expected to be released with the next monthly release.
- Warning (yellow): Signal the RC tagging date is getting closer (implementation idea #19988 (comment 1769312991))
- In-Progress (red): Final RC has been tagged, any commit that has not reached production prior to the tagging time is not included in the monthly release. This will reset to green after the minor version is released
- Planned Release
- Next version and release date (example visualization)
- Is the planned release open? (example visualization below)
- Open (green): Engineers can create security MRs, tag the issues with security-target, and expect the issues to be included in the upcoming planned release.
- Warning (yellow): Signal the merge date is getting closer
- In-Progress (red): (two days before release due date) Merging has started, which means that security issues without security-target label and their associated MRs cannot be included in the upcoming planned release.
- Upcoming planned release date
- Release versions supported by the GitLab maintenance policy (e.g. 16.8, 16.7, 16.6)
- Links
- Maintenance policy
- Backporting documentation
-
Security release tracking issue (issue search for
label = upcoming security release
) -
List of included security issues (the comment with the table of issues in the tracking issue)
- May have to be manually set (TBD)
Example Visualization
To clarify the "red-green status" and "pipeline view", I have manually put up a playground for visualization purposes (with manually picked metrics).
More screenshots and discussion in this comment.
Note: this visualization was prior to introducing the idea of "blue for in-progress" for the pipeline view.