Skip to content

Update lefthook config to check when audit_events.md is updated directly

Huzaifa Iftikhar requested to merge huzaifaiftikhar1_update_lefthook_config into master

What does this MR do and why?

  1. Currently, when doc/administration/audit_event_streaming/audit_event_types.md is updated directly the pre-push hook doesn't run gitlab:audit_event_types:check_docs
  2. However, the pipeline would fail as it will run the audit-event-types-verify lint job.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

Before After

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

  1. Checkout a local branch from current master and then update doc/administration/audit_event_streaming/audit_event_types.md and make some changes.
  2. Commit the changes and push upstream.
  3. Ensure that the changes are pushed and audit_event_types_docs check is not run.
  4. Checkout a local branch from this MR's branch and repeat steps 1-2.
  5. Ensure that the changes are not pushed upstream and the job audit_event_types_docs is executed and fails.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Merge request reports