@mattpolzin/harmony 5.7.0 → 6.0.0

package/man/harmony.1

@@ -1,6 +1,6 @@
 .\" Automatically generated by Pandoc 3.7.0.2
 .\"
-.TH "harmony" "1" "" "Version 5.7.0" "Harmony User\(cqs Guide"
+.TH "harmony" "1" "" "Version 6.0.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
@@ -92,6 +92,10 @@ Each release page also indicates the version of Idris 2 that particular
 release will build against.
 .PP
 Alternatively, you can build Harmony with Docker (see Docker Build).
+.SS Testing
+Tests can be run with \f[CR]make test\f[R].
+You\(cqll need a few common tools in your \f[CR]PATH\f[R] to run all the
+tests: \- \f[CR]realpath\f[R] \- \f[CR]sed\f[R] \- \f[CR]xargs\f[R]
 .SS Installation
 For any installation, you need to have a GitHub \c
 .UR https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token
@@ -258,11 +262,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,14 +392,16 @@ 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] [\-i/\-\-into {<branch\-name>}] [#label, ...]\f[R]
+.SS \f[CR]pr [\-\-draft | \-\-ready] [\-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
 PR.
 If there is not a PR, Harmony will help you create one.
 New and existing PRs can be marked as drafts by specifying the
-\f[CR]\-\-draft\f[R] flag with the \f[CR]pr\f[R] command.
+\f[CR]\-\-draft\f[R] flag with the \f[CR]pr\f[R] command or they can be
+marked as ready for review with the \f[CR]\-\-ready\f[R] flag.
+The default behavior for new PRs is to mark them ready.
 .PP
 If you need to create a PR still, you will be prompted for a branch to
 open the PR against (merge into, eventually), a title for the PR, and a
@@ -444,7 +458,7 @@ pre\-existing \f[CR]release/2_0\f[R] branch:
 .EX
 harmony pr \-\-into release/2_0
 .EE
-.SS \f[CR]quick [\-\-bugfix]\f[R]
+.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
@@ -454,6 +468,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.7.0",
+  "version": "6.0.0",
   "engines": {
     "node": ">=18.0.0"
   },
@@ -28,7 +28,6 @@
   "author": "Mathew Polzin",
   "license": "MIT",
   "dependencies": {
-    "octokit": "^3.1",
-    "simple-git": "^3.15"
+    "octokit": "^3.1"
   }
 }