Mergify
  • Home
  • Aboutย Us
  • Blog
  • Dashboard
  • Discussions
  • Changelog
  • Status
  1. ๐Ÿš€ Actions
« ๐ŸŽฏ Conditions assign »
  • โžก๏ธ Getting Started
    • Installation
    • Configuration
    • Understanding Mergify Check Report
    • Controlling Mergify with Commands
    • Required Permissions
  • ๐Ÿ”– Configuration File
    • File Used
    • Format
    • Data Types
    • YAML Anchors and Aliases
    • Disabling Rules
    • Extends
  • ๐ŸŽฏ Conditions
    • Grammar
    • Combining Conditions with Operators
    • Attributes
    • Operators
    • How To Match Lists
    • About Status Checks
    • About Branch Protection
  • ๐Ÿš€ Actions
    • assign
    • backport
    • close
    • copy
    • comment
    • delete_head_branch
    • dismiss_reviews
    • edit
    • label
    • merge
    • post_check
    • queue
    • rebase
    • request_reviews
    • review
    • update
    • squash
  • โš™๏ธ Commands
    • backport
    • copy
    • queue
    • rebase
    • refresh
    • squash
    • update
    • unqueue
    • requeue
  • ๐Ÿงช Example Rules
    • โœ… Automatic Merge when CI works and approving reviews
    • ๐Ÿ—‚ Merging based on Modified Files
    • ๐Ÿ– Less Strict Rules for Stable Branches
    • ๐ŸŽฌ Using Labels to Enable/Disable Merge
    • โšก๏ธ Using Labels to Prioritize Merge
    • ๐Ÿ™…๏ธ Require All Requested Reviews to Be Approved
    • โ˜‘๏ธ Matching Pull Requests with Task Lists
    • ๐Ÿค– Bots
  • ๐Ÿ”Œ API
    • Authentication
    • Going Further
  • ๐ŸŽ– Badge
    • Embedding
    • Styles
  • ๐Ÿ’ฌ FAQ
    • Mergify is unable to merge my pull request due to my branch protection settings
    • Why did Mergify seem to have merged my pull request whereas all conditions were not true?

๐Ÿš€ Actions๐Ÿ”—

When a pull request matches the list of ๐ŸŽฏ Conditions of a rule, the actions configured in that rule are executed by Mergify. The actions should be put under the actions key in the pull_request_rules entry โ€” see ๐Ÿ”– Configuration File.

The list of available actions is listed below, with their configuration options.

assign

Assign or de-assign a pull request from a user.

backport

Copy a pull request to another branch once it is merged.

close

Close pull requests.

comment

Post a comment on a pull request.

copy

Copy a pull request and create a new pull request.

delete_head_branch

Delete pull request head branch. Useful to clean pull request once closed.

dismiss_reviews

Dismiss previous reviews on a pull request.

edit

Edit pull request attributes such as: draft state, body, title.

label

Add or remove a label from a pull request.

merge

Merge a pull request.

post_check

Post custom status check to a pull request.

queue

Put a pull request in queue before merging.

rebase

Rebase a pull request on top of its base branch.

request_reviews

Request review from users or teams for a pull request.

review

Review a pull request.

squash

Squash a pull request.

update

Update a pull request with its base branch.

  • assign
  • backport
  • close
  • copy
  • comment
  • delete_head_branch
  • dismiss_reviews
  • edit
  • label
  • merge
  • post_check
  • queue
  • rebase
  • request_reviews
  • review
  • update
  • squash
© Copyright 2023, Mergify
Back to top