-test-bitbucket-branch-manager

Bitbucket-branch-manager is a CLI written in Nodejs. It help you manager remote branch and pull request by simple command line. This CLI follow Bitbucket API

Feature

• Create branch
• Delete branch
• Reset branch
• Open pull request
• Merge pull request

Install

You need install nodejs. Make sure nodejs was installed ( node>= 12)

$ node -v
$ npm -v

Install bitbucket-branch-manager

$ npm install -g bitbucket-branch-manager

Check bitbucket-branch-manager was installed

$ bbm -v

Setup your config

• Make sure your basic authentication bitbucket is set up

  $ bbm set --basic-auth-username <username> 
  $ bbm set --basic-auth-password <password> 
  

• Set default workspace

  $ bbm set --default-workspace <workspace>
  

• What is a workspace ? A workspace is where you will create repositories, collaborate on your code, and organize different streams of work in your Bitbucket Cloud account. At this time, you'll be provided with one workspace and one workspace ID.

• Check config

  $ bbm get
  

Comamnd line Document

1. Repositories list

• You can get your repositories list (limit 100 items):

  $ bbm repo
  

• Or use alias by the way

  # set index
  $ bbm repo --set-index-alias
  # check it
  $ bbm alias
  

2. Create branch

• This command will create new branch from another source branch, please make sure source branch or default source branch is exist
• Command: bbm new|n <repo|aliasId> <branch> [source]
• Option
  • -w <workspace> or --workspace <workspace>
• Set aliasId follow 1. Repositories list or if you've already done it:

  $ bbm alias 
  #or
  $ bbm a
  

• Set default source branch:

  # another branch you want, my example is master
  $ bbm set --default-branch-create-from master
  

• Examples:
  • Full command:

    $ bbm new test-repo test-branch master
    

  • Short command:

    # if not set default source branch
    $ bbm n 2 test-branch master
    # default source branch has aldready
    $ bbm n 2 test-branch
    

3. Delete branch

• Command: bbm delete|d <repo|aliasId> <branch>
• Option
  • -w <workspace> or --workspace <workspace>
• Examples:
  • Full command:

    $ bbm delete test-repo test-branch
    

  • Short command:

    $ bbm d 2 test-branch
    

4. Reset branch

• This command will delete and recreate branch from another source branch, please make sure source or default source branch is exist
• Command: bbm reset|r <repo|aliasId> [branch] [source]
• Option
  • -w <workspace> or --workspace <workspace>
• Set default source branch. Your branch you want reset will recreate from this:

  # another branch you want, my example is master
  $ bbm set --default-branch-reset-from master
  

• Set default branch will reset.

  # another branch you want, my example is master
  $ bbm set --default-branch-reset staging 
  

• Examples:
  • Full command:

    $ bbm reset test-repo test-branch master
    

  • Short command:

    # if you not set default branch
    $ bbm r 2 test-branch master
    # if default destination branch has aldready
    $ bbm r 2 test-branch
    # if default destination branch and default branch reset has aldready
    $ bbm r 2 # mean delete staging and recreate from master
    

5. Open pull request

• This command will create pull request your into another branch.
• Command: bbm open|o <repo|aliasId> <branch> [destination]
• Option
  • -w <workspace> or --workspace <workspace>
  • -t <title> or --title <title> if you want set title or not title default is branch name
  • -m or --merge if you want auto merge
• Set default destination

  # another branch you want, my example is master
  $ bbm set --default-branch-open-pull master
  

• Examples:
  • Full command

    $ bbm open test-repo test-branch master
    

  • Short command

    # if you not set default branch
    $ bbm o 2 test-branch master
    # if default destination branch has aldready
    $ bbm o 2 test-branch
    

6. Merge pull request

• This command will merge your pull request by id
• Command: bbm merge|m <repo> <pullId>
• Examples:
  • Full command:

    $ bbm merge test-repo 25
    

  • Short command:

    $ bbm m test repo 25
    

End

Thanks for spending your time to visit.