Skip to content

Add a meaningful audit event name for `only_allow_merge_if_pipeline_succeeds` in Project

Problem to solve

Some audit events are named audit_operation. This isn't a descriptive name and makes it difficult to differentiated from other events.

Additional context is available in this epic and in the parent epic.

Proposal

Add a meaningful name for the only_allow_merge_if_pipeline_succeeds audit event's update action that can be used to differentiate it from other events.

Naming should follow the noun_verb format and use the past tense. For example ci_variable_created.

For events created with audit_changes we can pass the event name using the event_type argument.

audit_changes(:email, as: 'email address', event_type: 'email_address_added')

Also consider this MR as an example of how to do this.

Implementation plan

  1. Add an meaningful event name to the only_allow_merge_if_pipeline_succeeds event in this file.
    • The name should follow the noun_verb format.
  2. Update the associated specs is required.

Notes