@mattpolzin/harmony 5.6.0 → 5.8.0

package/man/harmony.1

@@ -1,6 +1,6 @@
 .\" Automatically generated by Pandoc 3.7.0.2
 .\"
-.TH "harmony" "1" "" "Version 5.6.0" "Harmony User\(cqs Guide"
+.TH "harmony" "1" "" "Version 5.8.0" "Harmony User\(cqs Guide"
 .SH NAME
 Harmony \- Harmonize with coworkers around GitHub reviewing
 .SH SYNOPSIS
@@ -12,7 +12,7 @@ Harmony \- Harmonize with coworkers around GitHub reviewing
 .PD 0
 .P
 .PD
-\f[CR]harmony contribute [options] {uri | pr\-number}\f[R]
+\f[CR]harmony contribute [options]\f[R]
 .PD 0
 .P
 .PD
@@ -40,7 +40,7 @@ Harmony \- Harmonize with coworkers around GitHub reviewing
 .PD 0
 .P
 .PD
-\f[CR]harmony quick\f[R]
+\f[CR]harmony quick [options]\f[R]
 .PD 0
 .P
 .PD
@@ -258,11 +258,19 @@ Not all configuration properties can be read/set with this command.
 .SS Properties
 .TP
 \f[CR]requestTeams\f[R] (\f[CR]true\f[R]/\f[CR]false\f[R])
-When picking a reviewer from a team, request the team as a reviewer as
-well.
+When picking a team to review, request review from the whole team, not
+just one user on the team.
+If you have GitHub configured to pick a member of a team to review when
+the team is requested, you probably want to set this to \f[CR]true\f[R]
+so harmony tells GitHub the team from which GitHub should then pick an
+individual.
 .TP
 \f[CR]requestUsers\f[R] (\f[CR]true\f[R]/\f[CR]false\f[R])
-When requesting a team as a reviewer, pick a user to review as well.
+When requesting a team to review, pick a user from the team to review as
+well.
+If you have GitHub configured to pick a member of a team to review when
+the team is requested, you probably want to set this to \f[CR]false\f[R]
+so harmony does not also pick a user.
 .TP
 \f[CR]commentOnRequest\f[R] (\f[CR]none\f[R]/\f[CR]name\f[R]/\f[CR]at\-mention\f[R])
 When requesting a reviewer chosen by Harmony, comment on the pull
@@ -380,7 +388,7 @@ configured GitHub organization.
 .PP
 Running \f[CR]harmony list <team>\f[R] will list the members of the
 given GitHub Team.
-.SS \f[CR]pr [\-\-draft] [#label, ...]\f[R]
+.SS \f[CR]pr [\-\-draft] [\-i/\-\-into {<branch\-name>}] [#label, ...]\f[R]
 With a branch checked out will reach out to GitHub to determine if there
 is an open PR for that branch.
 If there is a PR, Harmony will print a URI that can be used to view the
@@ -401,6 +409,15 @@ If you do not have an \f[CR]EDITOR\f[R] environment variable set, you
 will still be able to enter a description from the command line but PR
 templates are only supported when an \f[CR]EDITOR\f[R] is specified.
 .PP
+If you are creating a new PR from a branch that refers to a GitHub issue
+(and you have GitHub branch parsing enabled in your harmony config) then
+harmony will prepend the issue information onto your new PR description
+in a commented out block for you to reference or copy into the PR
+description as needed.
+.PP
+You can specify the branch to merge into via the \f[CR]\-\-into\f[R] CLI
+argument if you want to as an alternative to the interactive prompt.
+.PP
 You can also specify any number of labels to apply by prefixing them
 with `#'.
 For example, \f[CR]harmony pr #backport #bugfix\f[R] would create a PR
@@ -428,7 +445,14 @@ Create a PR for the current branch and add the \f[CR]urgent\f[R] label:
 .EX
 harmony pr #urgent
 .EE
-.SS \f[CR]quick [\-\-bugfix]\f[R]
+.PP
+Create a pull request that will merge into the hypothetical
+pre\-existing \f[CR]release/2_0\f[R] branch:
+.IP
+.EX
+harmony pr \-\-into release/2_0
+.EE
+.SS \f[CR]quick [\-\-bugfix] [issue\-title] [...]\f[R]
 Helps you create a new GitHub issue and a branch to work on that issue
 all in one go.
 The branch name will be structured such that if you have GitHub branch
@@ -438,6 +462,12 @@ the issue created now.
 By default the branch created will be prefixed with \f[CR]feature\f[R]
 but if you specify the \f[CR]\-\-bugfix\f[R] flag then the branch\(cqs
 prefix will be \f[CR]bugfix\f[R].
+.PP
+Any additional arguments other than \f[CR]\-\-bugfix\f[R] will be used
+as the issue\(cqs title.
+If you don\(cqt specify the title as additional arguments, you will be
+prompted for one interactively.
+You will also be prompted for an issue description.
 .SS \f[CR]reflect\f[R]
 Show a summary of your review requests and authored pull requests.
 .SS \f[CR]request {team\-slug | +user\-login} [options]\f[R]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mattpolzin/harmony",
-  "version": "5.6.0",
+  "version": "5.8.0",
   "engines": {
     "node": ">=18.0.0"
   },