Skip to content
GitLab
Next
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • GitLab GitLab
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 44,758
    • Issues 44,758
    • List
    • Boards
    • Service Desk
    • Milestones
    • Iterations
    • Requirements
  • Merge requests 1,331
    • Merge requests 1,331
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
    • Test Cases
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Container Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Metrics
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Code review
    • Insights
    • Issue
    • Repository
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • GitLab.orgGitLab.org
  • GitLabGitLab
  • Issues
  • #224129
Closed
Open
Issue created Jun 24, 2020 by Brandon Butler@bbutler385 of 5 checklist items completed5/5 checklist items

Group Push Rules API

Problem to solve

Currently, there is an API for project level push rules. Groups have no such equivalent. The feature for push rules for groups in the UI is fairly new (issue: #34370 (closed)) but didn't appear to include the development of an API.

Here's the documentation of the push rules API for projects: https://docs.gitlab.com/ee/api/projects.html#push-rules-starter

Intended users

Anybody in a group managed account that wants to script the management (create/edit/delete) of push rules for groups in the GitLab API.

Proposal

Add API functionality, and matching documentation, for creating/editing/destroying (sub)group level push rules.

  • Drop feature flag for Group Push Rule - Verification complete on staging
  • Retrieve group push rules GET /groups/:id/push_rule - Verification complete
  • Add group push rules POST /groups/:id/push_rule - Verification complete
  • Edit group push rules PUT /groups/:id/push_rule - Verification complete
  • Delete group push rules DELETE /groups/:id/push_rule - Verification complete

Further details

We have a need for push rules to be set across our namespace, however, for a temporary period of time we would like certain subgroups to be opted out of these push rules while code from a deprecating SCM is being mirrored over into GitLab. Our namespace contains several thousand projects, so doing this manually in the UI would be a poor experience.

Links / references

Edited Sep 04, 2020 by Aishwarya Subramanian
Assignee
Assign to
Time tracking