[Feature flag] Enable Project Quality Summary MVC (:project_quality_summary_page)
Summary
This issue is to rollout the Project Quality Summary on production,
that is currently behind the :project_quality_summary_page
feature flag.
Blockers
To summarize, the data for this dashboard comes from only the latest pipeline for the project's default branch. This means that even if the project's pipeline has unit test jobs, code coverage jobs, and code quality jobs configured, the project quality page can still show blank cards sometimes - for example: if the latest pipeline failed, if those jobs failed, if those jobs aren't configured to run for the default branch, etc.
As long as users are made aware of this limitation and are willing to use the feature as-is, the feature flag can be enabled for projects using this command in #production:
/chatops run feature set --project=path/to/a-project,path/to/another-project project_quality_summary_page true
Owners
- Team: grouppipeline execution
- Most appropriate slack channel to reach out to:
#g_pipeline-execution
- Best individual to reach out to:
@jreporter
,@rutshah
Stakeholders
Expectations
What are we expecting to happen?
A new tab should appear on the project CI/CD analytics page.
What might happen if this goes wrong?
What can we monitor to detect problems with this?
Rollout Steps
Rollout on non-production environments
- Ensure that the feature MRs have been deployed to non-production environments.
-
/chatops run auto_deploy status <merge-commit-of-your-feature>
-
-
Enable the feature globally on non-production environments. -
/chatops run feature set project_quality_summary_page true --dev
-
/chatops run feature set project_quality_summary_page true --staging
-
-
Verify that the feature works as expected. Posting the QA result in this issue is preferable.
Specific rollout on production
- Ensure that the feature MRs have been deployed to both production and canary.
-
/chatops run auto_deploy status <merge-commit-of-your-feature>
-
- If you're using project-actor, you must enable the feature on these entries:
-
/chatops run feature set --project=gitlab-org/gitlab project_quality_summary_page true
-
/chatops run feature set --project=gitlab-org/gitlab-foss project_quality_summary_page true
-
/chatops run feature set --project=gitlab-com/www-gitlab-com project_quality_summary_page true
-
Preparation before global rollout
-
Check if the feature flag change needs to be accompanied with a change management issue. Cross link the issue here if it does. -
Ensure that you or a representative in development can be available for at least 2 hours after feature flag updates in production. If a different developer will be covering, or an exception is needed, please inform the oncall SRE by using the @sre-oncall
Slack alias. -
Ensure that documentation has been updated (More info). -
Announce on the feature issue an estimated time this will be enabled on GitLab.com. -
If the feature might impact the user experience, notify #support_gitlab-com
and your team channel (more guidance when this is necessary in the dev docs).
Global rollout on production
All /chatops
commands that target production should be done in the #production
slack channel for visibility.
-
Incrementally roll out the feature. - If the feature flag in code has an actor, perform actor-based rollout.
-
/chatops run feature set project_quality_summary_page <rollout-percentage> --actors
-
- If the feature flag in code does NOT have an actor, perform time-based rollout (random rollout).
-
/chatops run feature set project_quality_summary_page <rollout-percentage>
-
- Enable the feature globally on production environment.
-
/chatops run feature set project_quality_summary_page true
-
- If the feature flag in code has an actor, perform actor-based rollout.
-
Announce on the feature issue that the feature has been globally enabled. -
Wait for at least one day for the verification term.
Release the feature
After the feature has been deemed stable, the clean up should be done as soon as possible to permanently enable the feature and reduce complexity in the codebase.
-
Create a merge request to remove project_quality_summary_page
feature flag. Ask for review and merge it.-
Remove all references to the feature flag from the codebase. -
Remove the YAML definitions for the feature from the repository. -
Create a changelog entry.
-
-
Ensure that the cleanup MR has been deployed to both production and canary. If the merge request was deployed before the code cutoff, the feature can be officially announced in a release blog post. -
/chatops run auto_deploy status <merge-commit-of-cleanup-mr>
-
-
Close the feature issue to indicate the feature will be released in the current milestone. -
Clean up the feature flag from all environments by running these chatops command in #production
channel:-
/chatops run feature delete project_quality_summary_page --dev
-
/chatops run feature delete project_quality_summary_page --staging
-
/chatops run feature delete project_quality_summary_page
-
-
Close this rollout issue.
Rollback Steps
-
This feature can be disabled by running the following Chatops command:
/chatops run feature set project_quality_summary_page false