@mattpolzin/harmony 6.3.0 → 6.4.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 +11 -5
- package/harmony +1496 -939
- package/man/harmony.1 +10 -13
- 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 6.
|
|
3
|
+
.TH "harmony" "1" "" "Version 6.4.0" "Harmony User\(cqs Guide"
|
|
4
4
|
.SH NAME
|
|
5
5
|
Harmony \- Harmonize with coworkers around GitHub reviewing
|
|
6
6
|
.SH SYNOPSIS
|
|
@@ -85,17 +85,6 @@ Running Harmony requires NodeJS 18+ (and a local installation of
|
|
|
85
85
|
If you\(cqd like to try Harmony out without even \(lqinstalling\(rq it
|
|
86
86
|
and you have Nix installed with flakes enabled, you can run it as
|
|
87
87
|
\f[CR]nix run github:mattpolzin/harmony\f[R].
|
|
88
|
-
.SS Build time
|
|
89
|
-
Building the latest commits of Harmony requires a HEAD build of the
|
|
90
|
-
Idris 2 compiler.
|
|
91
|
-
Each release page also indicates the version of Idris 2 that particular
|
|
92
|
-
release will build against.
|
|
93
|
-
.PP
|
|
94
|
-
Alternatively, you can build Harmony with Docker (see Docker Build).
|
|
95
|
-
.SS Testing
|
|
96
|
-
Tests can be run with \f[CR]make test\f[R].
|
|
97
|
-
You\(cqll need a few common tools in your \f[CR]PATH\f[R] to run all the
|
|
98
|
-
tests: \- \f[CR]realpath\f[R] \- \f[CR]sed\f[R] \- \f[CR]xargs\f[R]
|
|
99
88
|
.SS Bash completion
|
|
100
89
|
Set up Bash completion by adding the following to your Bash resource
|
|
101
90
|
file or profile:
|
|
@@ -226,6 +215,10 @@ Optionally extract a Jira ticket slug or GitHub issue number from the
|
|
|
226
215
|
branch name and prepend it to the PR title or body to link the PR and
|
|
227
216
|
ticket/issue.
|
|
228
217
|
.TP
|
|
218
|
+
\f[CR]addPrTreeDescription\f[R] (\f[CR]true\f[R]/\f[CR]false\f[R])
|
|
219
|
+
Determines whether to add a tree of PRs to the description for any PR
|
|
220
|
+
that is into a branch other than the \f[CR]mainBranch\f[R] configured.
|
|
221
|
+
.TP
|
|
229
222
|
\f[CR]defaultRemote\f[R] (optional string)
|
|
230
223
|
When pushing new branches, what remote destination should be used.
|
|
231
224
|
.TP
|
|
@@ -333,12 +326,16 @@ configured GitHub organization.
|
|
|
333
326
|
.PP
|
|
334
327
|
Running \f[CR]harmony list <team>\f[R] will list the members of the
|
|
335
328
|
given GitHub Team.
|
|
336
|
-
.SS \f[CR]pr [\-\-draft | \-\-ready] [\-i/\-\-into {<branch\-name>}] [#label, ...]\f[R]
|
|
329
|
+
.SS \f[CR]pr [\-\-draft | \-\-ready] [\-i/\-\-into {<branch\-name>}] [\-\-print\-tree] [#label, ...]\f[R]
|
|
337
330
|
With a branch checked out will reach out to GitHub to determine if there
|
|
338
331
|
is an open PR for that branch.
|
|
339
332
|
If there is a PR, Harmony will print a URI that can be used to view the
|
|
340
333
|
PR.
|
|
341
334
|
If there is not a PR, Harmony will help you create one.
|
|
335
|
+
The \f[CR]\-\-print\-tree\f[R] flag will print a tree of PRs for
|
|
336
|
+
branches between the current one and the \f[CR]mainBranch\f[R] of the
|
|
337
|
+
repository instead of just printing the URI for the current branch\(cqs
|
|
338
|
+
PR.
|
|
342
339
|
New and existing PRs can be marked as drafts by specifying the
|
|
343
340
|
\f[CR]\-\-draft\f[R] flag with the \f[CR]pr\f[R] command or they can be
|
|
344
341
|
marked as ready for review with the \f[CR]\-\-ready\f[R] flag.
|