@mattpolzin/harmony 5.7.0 → 5.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +11 -6
  2. package/harmony +706 -629
  3. package/man/harmony.1 +21 -7
  4. package/package.json +1 -1
package/man/harmony.1 CHANGED
@@ -1,6 +1,6 @@
1
1
  .\" Automatically generated by Pandoc 3.7.0.2
2
2
  .\"
3
- .TH "harmony" "1" "" "Version 5.7.0" "Harmony User\(cqs Guide"
3
+ .TH "harmony" "1" "" "Version 5.8.0" "Harmony User\(cqs Guide"
4
4
  .SH NAME
5
5
  Harmony \- Harmonize with coworkers around GitHub reviewing
6
6
  .SH SYNOPSIS
@@ -12,7 +12,7 @@ Harmony \- Harmonize with coworkers around GitHub reviewing
12
12
  .PD 0
13
13
  .P
14
14
  .PD
15
- \f[CR]harmony contribute [options] {uri | pr\-number}\f[R]
15
+ \f[CR]harmony contribute [options]\f[R]
16
16
  .PD 0
17
17
  .P
18
18
  .PD
@@ -40,7 +40,7 @@ Harmony \- Harmonize with coworkers around GitHub reviewing
40
40
  .PD 0
41
41
  .P
42
42
  .PD
43
- \f[CR]harmony quick\f[R]
43
+ \f[CR]harmony quick [options]\f[R]
44
44
  .PD 0
45
45
  .P
46
46
  .PD
@@ -258,11 +258,19 @@ Not all configuration properties can be read/set with this command.
258
258
  .SS Properties
259
259
  .TP
260
260
  \f[CR]requestTeams\f[R] (\f[CR]true\f[R]/\f[CR]false\f[R])
261
- When picking a reviewer from a team, request the team as a reviewer as
262
- well.
261
+ When picking a team to review, request review from the whole team, not
262
+ just one user on the team.
263
+ If you have GitHub configured to pick a member of a team to review when
264
+ the team is requested, you probably want to set this to \f[CR]true\f[R]
265
+ so harmony tells GitHub the team from which GitHub should then pick an
266
+ individual.
263
267
  .TP
264
268
  \f[CR]requestUsers\f[R] (\f[CR]true\f[R]/\f[CR]false\f[R])
265
- When requesting a team as a reviewer, pick a user to review as well.
269
+ When requesting a team to review, pick a user from the team to review as
270
+ well.
271
+ If you have GitHub configured to pick a member of a team to review when
272
+ the team is requested, you probably want to set this to \f[CR]false\f[R]
273
+ so harmony does not also pick a user.
266
274
  .TP
267
275
  \f[CR]commentOnRequest\f[R] (\f[CR]none\f[R]/\f[CR]name\f[R]/\f[CR]at\-mention\f[R])
268
276
  When requesting a reviewer chosen by Harmony, comment on the pull
@@ -444,7 +452,7 @@ pre\-existing \f[CR]release/2_0\f[R] branch:
444
452
  .EX
445
453
  harmony pr \-\-into release/2_0
446
454
  .EE
447
- .SS \f[CR]quick [\-\-bugfix]\f[R]
455
+ .SS \f[CR]quick [\-\-bugfix] [issue\-title] [...]\f[R]
448
456
  Helps you create a new GitHub issue and a branch to work on that issue
449
457
  all in one go.
450
458
  The branch name will be structured such that if you have GitHub branch
@@ -454,6 +462,12 @@ the issue created now.
454
462
  By default the branch created will be prefixed with \f[CR]feature\f[R]
455
463
  but if you specify the \f[CR]\-\-bugfix\f[R] flag then the branch\(cqs
456
464
  prefix will be \f[CR]bugfix\f[R].
465
+ .PP
466
+ Any additional arguments other than \f[CR]\-\-bugfix\f[R] will be used
467
+ as the issue\(cqs title.
468
+ If you don\(cqt specify the title as additional arguments, you will be
469
+ prompted for one interactively.
470
+ You will also be prompted for an issue description.
457
471
  .SS \f[CR]reflect\f[R]
458
472
  Show a summary of your review requests and authored pull requests.
459
473
  .SS \f[CR]request {team\-slug | +user\-login} [options]\f[R]
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mattpolzin/harmony",
3
- "version": "5.7.0",
3
+ "version": "5.8.0",
4
4
  "engines": {
5
5
  "node": ">=18.0.0"
6
6
  },