Skip to content

Update license classification names in merge request UI

UPDATE: Moved details to #14061 (closed), since these items need to be completed at the same time.

Problem

License compliance classification names have changed, per this issue: #12937 (closed). In %12.5 we are updating/adding the license management/policy section #14061 (closed), which will also update the new classification names in that section. However, the classification names need to be updated in the UI seen in the MR widget.

Solution

Update license names that are seen in the MR. This issue is closely related to #12530 (closed)

Current New
unclassified_current unclassified_new
clarify_text_current clarify_text_new
Classification names that require change:
  • Uncategorized, newly detected or admin has not selected classification
  • Approve => Allowed, admin has classified license as acceptable
  • Approve => Allow, used in the call-to-action seen in the MR (admin view) to classify license as Allowed
  • Blacklist => Denied, project participant views this classification when admin classified license as not allowed
  • Blacklist => Deny, used in the call-to-action seen in the MR (admin view) to classify license as unacceptable

Proposed Backend Tasks

These tasks need to be split off as a sub-issue when work begins on them.

  • Rename approval_status column to classification.
  • Rename blacklisted enum name to denied.
  • Rename approved enum name to allowed.

The following are non-essential tasks but are recommended for maintaining consistency and for maintaining a ubiquitous language.

  • Add classification attribute to ManagedLicenseEntity.
  • Deprecate approval_status attribute from ManagedLicenseEntity.
  • Update API documentation for JSON entity changes. doc/api/managed_licenses.md.
  • Add classification to list of permitted params in ManagedLicensesController.
  • Deprecate approval_status from permitted params in ManagedLicensesController.
  • Add classification parameter to ee/lib/api/managed_licenses.
  • Deprecate approval_status parameter from ee/lib/api/managed_licenses.
  • Add feature flag to toggle between approval_status and classification at API boundaries.
  • Add spdx_id attribute to JSON entities. (Need to confirm which JSON serializers)
Edited by Kyle Mann