#Auto merge

This plugin allows you to automatically merge the update branch into the source branch.

For our bot to commit and push to your repository, you will have to setup and SSH keypair as explained here.

version: "1"
packageManagers:
  - packageManager:
      name: npm
    actions:
      - name: auto-merge
        on:
          - success

When a dependency update fails, Pmbot reverts it. For this reason, this plugin will not work when failure is used in the on property.

You can customize this plugin by providing a custom configuration:

version: '1'
packageManagers:
  - packageManager:
      name: npm
    actions:
      - name: auto-merge
        on:
          - success
        config:
          commitMessage: 'chore: update {{slug}} dependencies'

#squash

Default: true

Whether to squash commits into a single one. This ensures a clean Git history.

#commitMessage

Default: chore: update {{slug}} dependencies

The commit message used for the merge/squash commit.

This handlebars template is passed the following context:

{
  "slug": "npm-0"
}
Property Description
slug Key that identifies the update in your configuration. For example, "npm", or, "npm-0" when there are multiple packageManagerUpdates configured with npm as the packageManager.name.

#removeUpdateBranch

Default: true

Whether the update branch should be removed.