@mattpolzin/harmony 5.6.0 → 5.7.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.
- package/README.md +16 -2
- package/harmony +564 -511
- package/man/harmony.1 +18 -2
- 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.
|
|
3
|
+
.TH "harmony" "1" "" "Version 5.7.0" "Harmony User\(cqs Guide"
|
|
4
4
|
.SH NAME
|
|
5
5
|
Harmony \- Harmonize with coworkers around GitHub reviewing
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -380,7 +380,7 @@ configured GitHub organization.
|
|
|
380
380
|
.PP
|
|
381
381
|
Running \f[CR]harmony list <team>\f[R] will list the members of the
|
|
382
382
|
given GitHub Team.
|
|
383
|
-
.SS \f[CR]pr [\-\-draft] [#label, ...]\f[R]
|
|
383
|
+
.SS \f[CR]pr [\-\-draft] [\-i/\-\-into {<branch\-name>}] [#label, ...]\f[R]
|
|
384
384
|
With a branch checked out will reach out to GitHub to determine if there
|
|
385
385
|
is an open PR for that branch.
|
|
386
386
|
If there is a PR, Harmony will print a URI that can be used to view the
|
|
@@ -401,6 +401,15 @@ If you do not have an \f[CR]EDITOR\f[R] environment variable set, you
|
|
|
401
401
|
will still be able to enter a description from the command line but PR
|
|
402
402
|
templates are only supported when an \f[CR]EDITOR\f[R] is specified.
|
|
403
403
|
.PP
|
|
404
|
+
If you are creating a new PR from a branch that refers to a GitHub issue
|
|
405
|
+
(and you have GitHub branch parsing enabled in your harmony config) then
|
|
406
|
+
harmony will prepend the issue information onto your new PR description
|
|
407
|
+
in a commented out block for you to reference or copy into the PR
|
|
408
|
+
description as needed.
|
|
409
|
+
.PP
|
|
410
|
+
You can specify the branch to merge into via the \f[CR]\-\-into\f[R] CLI
|
|
411
|
+
argument if you want to as an alternative to the interactive prompt.
|
|
412
|
+
.PP
|
|
404
413
|
You can also specify any number of labels to apply by prefixing them
|
|
405
414
|
with `#'.
|
|
406
415
|
For example, \f[CR]harmony pr #backport #bugfix\f[R] would create a PR
|
|
@@ -428,6 +437,13 @@ Create a PR for the current branch and add the \f[CR]urgent\f[R] label:
|
|
|
428
437
|
.EX
|
|
429
438
|
harmony pr #urgent
|
|
430
439
|
.EE
|
|
440
|
+
.PP
|
|
441
|
+
Create a pull request that will merge into the hypothetical
|
|
442
|
+
pre\-existing \f[CR]release/2_0\f[R] branch:
|
|
443
|
+
.IP
|
|
444
|
+
.EX
|
|
445
|
+
harmony pr \-\-into release/2_0
|
|
446
|
+
.EE
|
|
431
447
|
.SS \f[CR]quick [\-\-bugfix]\f[R]
|
|
432
448
|
Helps you create a new GitHub issue and a branch to work on that issue
|
|
433
449
|
all in one go.
|