x

Programs, configuration and documentation that don't fit anywhere else
Log | Files | Refs | README | LICENSE

bbpr.1 (1230B)


      1 .Dd
      2 .Dt BBPR 1
      3 .Sh NAME
      4 .Nm bbpr
      5 .Nd create a Bitbucket pull request
      6 .Sh SYNOPSIS
      7 .Nm
      8 .Op Ar branch
      9 .Sh DESCRIPTION
     10 .Nm
     11 creates a Bitbucket pull request to merge the currently checked-out branch
     12 with the named
     13 .Ar branch
     14 of the remote
     15 .Ar origin .
     16 If no destination
     17 .Ar branch
     18 is specified,
     19 .Ar main ,
     20 then
     21 .Ar master
     22 are tried.
     23 A URL pointing to the pull request is created on success.
     24 .Pp
     25 .Nm
     26 prompts for a pull request
     27 .Dq cover letter ,
     28 similar to
     29 .Xr git-commit 1 ,
     30 by reading the
     31 .Ev EDITOR
     32 environment variable;
     33 otherwise
     34 .Xr ed 1 .
     35 The first line is the pull request's title.
     36 The second line is ignored and should be empty.
     37 The rest becomes the description.
     38 .Sh FILES
     39 .Bl -tag -width Ds
     40 .It Pa $HOME/.config/atlassian/bitbucket.org
     41 Configuration file containing a Bitbucket API token.
     42 .El
     43 .Sh EXIT STATUS
     44 .Ex
     45 .Sh EXAMPLES
     46 Create a pull request to merge test_refactor into main:
     47 .Bd -literal -offset indent
     48 git switch test_refactor
     49 bbpr
     50 .Ed
     51 .Pp
     52 Create a pull request to merge typo into test_refactor:
     53 .Bd -literal -offset indent
     54 git switch typo
     55 bbpr test_refactor
     56 .Ed
     57 .Sh SEE ALSO
     58 .Xr curl 1 ,
     59 .Xr jq 1 ,
     60 .Lk https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pullrequests Bitbucket pull requests API reference