Add commit_committer_check to the /projects/:id/push_rule API endpoint

Problem to solve

The /projects/:id/push_rule API endpoint doesn't support the commit_committer_check attribute for project push rules. This corresponds to the Committer restriction: Users can only push commits to this repository that were committed with one of their own verified emails. checkbox in the UI for project push rules.

This proposal is to add commit_committer_check as an attribute for the /projects/:id/push_rule API endpoint.

Customer ticket: https://gitlab.zendesk.com/agent/tickets/114544 (internal use only)

Target audience

The customer would like to set this attribute via the API.

  • Delaney, Development Team Lead, https://design.gitlab.com/research/personas#persona-delaney

  • Sasha, Software Developer, https://design.gitlab.com/research/personas#persona-sasha

  • Devon, DevOps Engineer, https://design.gitlab.com/research/personas#persona-devon

  • Sidney, Systems Administrator, https://design.gitlab.com/research/personas#persona-sidney

  • Sam, Security Analyst, https://design.gitlab.com/research/personas#persona-sam

Proposal

Add the commit_committer_check to the Project Push Rules API.

Endpoints defined in: https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/api/project_push_rule.rb Attributes defined in: https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/ee/api/entities.rb

Documentation

Will need to add the commit_committer_check attribute to Project Push Rules API documentation.

What does success look like, and how can we measure that?

Customers can access and edit the commit_committer_check attribute for a project's push rule via the API.

What is the type of buyer?

This option is available in Premium and above.

Links / references

cc/ @jramsay

Assignee Loading
Time tracking Loading