git-auto-merger
TypeScript icon, indicating that this package has built-in type declarations

2.3.0 • Public • Published

git-auto-merger

This CLI helps to create an auto-merge functionality for git. When it fails to merge (due to conflicts), you can send an alert out.

oclif Version CircleCI Downloads/week License

Usage

$ npm install -g git-auto-merger
$ git-auto-merger COMMAND
running command...
$ git-auto-merger (--version)
git-auto-merger/2.3.0 linux-x64 node-v16.19.0
$ git-auto-merger --help [COMMAND]
USAGE
  $ git-auto-merger COMMAND
...

Commands

git-auto-merger help [COMMAND]

Display help for git-auto-merger.

USAGE
  $ git-auto-merger help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for git-auto-merger.

See code: @oclif/plugin-help

git-auto-merger merge

Tries to merge the base branch into all of the other ones that have been specified or match a pattern.

USAGE
  $ git-auto-merger merge -b <value> [-e <value>] [-i <value>] [-m <value> -P <value>] [-c] [-P]

FLAGS
  -P, --project-name=<value>        The name of the project when sending the notification
  -P, --push-commit                 Push the changes of the merge
  -b, --base-branch=<value>         (required) The base branch that we want to merge into other branches
  -c, --commit                      Commit the changes when the merge takes place
  -e, --exclude-pattern=<value>...  The regex pattern(s) to exclude when running a merge. For example: ^main$
  -i, --include-pattern=<value>...  The regex patterns(s) to include when running a merge. For example: feature.+
  -m, --notify-email=<value>...     Send a notification via SMTP if the merge cannot take place

DESCRIPTION
  Tries to merge the base branch into all of the other ones that have been specified or match a pattern.

  Exclusion takes preference over inclusion, so we will ignore a branch if it triggers in the include and exclude
  patterns.

EXAMPLES
  $ git-auto-merger merge --base-branch=develop --include-pattern='develop
 --include-pattern='feature/.*' --exclude-pattern='main' --notify-email="dev@example.com" --project-name=Test

See code: dist/commands/merge.ts

git-auto-merger set credentials smtp

Set the SMTP credentials that should be used to send the alert

USAGE
  $ git-auto-merger set credentials smtp -h <value> -u <value> -p <value> -P <value> -f <value> [-s]

FLAGS
  -P, --port=<value>      (required) The SMTP port to use
  -f, --from=<value>      (required) The from email address
  -h, --host=<value>      (required) The SMTP host to connect to
  -p, --password=<value>  (required) The email password
  -s, --tls               TLS enabled
  -u, --username=<value>  (required) The email username

DESCRIPTION
  Set the SMTP credentials that should be used to send the alert

EXAMPLES
  $ git-auto-merger set credentials smtp  --host=smtp.postmarkapp.com --port=587 --username=xxxxx-xxxxx-xxxxx --password=xxxxx-xxxxx-xxxxx --tls --from=info@example.com

Package Sidebar

Install

npm i git-auto-merger

Weekly Downloads

30

Version

2.3.0

License

MIT

Unpacked Size

40.9 kB

Total Files

38

Last publish

Collaborators

  • entrostat-developer