Deprecate GraphQL name field in CiMinutesProjectMonthlyUsage

GitLab customers with an active subscriptions can reach out to GitLab Support when encountering unexpected problems with this change.


Deprecation Summary

The field name in CiMinutesProjectMonthlyUsage is being replaced by the field project of type Project because we needed some extra fields from project as part of !95259 (comment 1072458728)

Product Usage

Customers could get the name of the project in the query, now we return the entire project type, so they can query project.name instead.

  • Usage of the deprecated field - Kibana logs - whole retention period (7 days) - about 1k hits
  • Only one user (dashboard)

Breaking Change?

Yes: We'll use now project.name instead of name in the query.

Affected Customers

  • GitLab.com
  • Self-managed
  • Dedicated

Affected Tier

All tiers

Deprecation Milestone

%17.7 (The field has the deprecation note on it since %15.6 -> !95259 (merged))

Planned Removal Milestone

%18.0

Links

  • Simply removing this field.
  • Deprecation MR: !172880 (merged)
  • MR that added the deprecation note on GraphQL field: !95259 (merged)
  • MR that removed the field: !188402 (merged)

Checklists

Timeline

Communication Plan

DRIs: @sheldonled

  • Product Manager: @alex_martin
  • As soon as possible, but no later than the third milestone preceding the major release (for example, given the following release schedule: 17.8, 17.9, 17.10, 17.11, 18.0 – 17.9 is the third milestone preceding the major release):
    • A deprecation announcement entry has been created so the deprecation will appear in release posts and on the general deprecation page.
    • Documentation has been updated to mark the feature as deprecated.
    • ☝️ Deprecation MR: !172880 (merged)
  • On the major milestone:
    • The deprecated item has been removed: !188402 (merged)
    • If the removal of the deprecated item is a breaking change, the merge request is labeled breaking change.
    • Document the migration plan for users, clearly outlining the actions they need to take to mitigate the impact of the breaking change.
      • Documentation has been added to the deprecation annotation in the field

Approvals

  • Product Manager @alex_martin
  • Engineering Manager @jameslopez
  • Senior Engineering Manager / Director @jeromezng
  • Group / Director of Product Management @ofernandez2

References

  • Deprecations, removals, and breaking changes
  • Deprecation guidelines
  • Deprecations and removals doc styleguide
  • REST API Deprecations and REST API breaking changes.
  • GraphQL Deprecations and GraphQL API breaking changes.
  • GitLab release and maintenance policy
  • Videos 📺
    • How to deprecate and remove features in GitLab releases
    • Review of GitLab deprecations and removals policy & Runner team deprecations and removals process
Edited Apr 23, 2025 by Sheldon Led
Assignee Loading
Time tracking Loading