Migrate Contribution Analytics to Vue 3
Migrate the Contribution Analytics page entrypoint(s) to Vue 3 behind a feature flag.
Docs: Contribution Analytics
Scope
This issue covers only the flag-gated rollout switch from Option 1 of the Vue 3 migration guide: add a single feature flag, add a vue3_migration.yml per entrypoint, and smoke test the affected pages. Full Vue 3 compliance (fixing compatibility issues, migrating unit tests) is not required here. Capture anything found during smoke testing in follow-up issues instead.
Implementation plan
1. Add the feature flag
Create vue3_migrate_contribution_analytics using bin/feature-flag:
type: beta,default_enabled: false,group: group::optimize- Read the
milestonevalue from theVERSIONfile - Set
feature_issue_urlto this issue - Use
useras the feature flag actor during rollout - Create a rollout issue from the "Feature Flag Roll Out" template and link it as
rollout_issue_url - Link the rollout issue to the parent epic gitlab-org&23041
2. Add a vue3_migration.yml per entrypoint
Create this file next to each index.js listed below:
status: rollout
feature_flag: vue3_migrate_contribution_analytics
group: group::optimize
migration_issue: https://gitlab.com/gitlab-org/gitlab/-/issues/607822Entrypoints:
-
ee/app/assets/javascripts/pages/groups/contribution_analytics/show/index.js(EE, group level)
3. Document existing test coverage in the MR
- Add a section to the MR description listing which functionality of the feature is currently tested and where those tests are located, as in this example
4. Smoke test
Enable the flag locally and confirm the browser console logs [gitlab] [V] Using Vue.js 3 on each page, then verify the key workflows:
- Push, merge request, and issue charts render
- Changing the date range updates the charts
- Contributions table renders and sorts per column
5. Follow-ups
- Open follow-up issues for any Vue 3 compatibility problems found during smoke testing and link them here
References
- Vue 3 migration guide, Option 1 (recommended)
- Example migration MR: gitlab-org/gitlab!247789
- Parent epic: gitlab-org&23041
Edited by 🤖 GitLab Bot 🤖