@mattpolzin/harmony 5.8.0 → 6.1.0

package/man/harmony.1

@@ -1,6 +1,6 @@
 .\" Automatically generated by Pandoc 3.7.0.2
 .\"
-.TH "harmony" "1" "" "Version 5.8.0" "Harmony User\(cqs Guide"
+.TH "harmony" "1" "" "Version 6.1.0" "Harmony User\(cqs Guide"
 .SH NAME
 Harmony \- Harmonize with coworkers around GitHub reviewing
 .SH SYNOPSIS
@@ -92,8 +92,26 @@ 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 Installation
-For any installation, you need to have a GitHub \c
+.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 Bash completion
+Set up Bash completion by adding the following to your Bash resource
+file or profile:
+.IP
+.EX
+eval \(dq$(harmony \-\-bash\-completion\-script)\(dq
+.EE
+.SS Zsh completion
+Zsh completion is supported via \f[CR]bashcompinit\f[R] and can be
+loaded by adding the following to your Zsh resource file or profile:
+.IP
+.EX
+eval \(dq$(harmony \-\-zsh\-completion\-script)\(dq
+.EE
+.SS Initial configuration
+For most things harmony does, 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
 Personal Access Token
 .UE \c
@@ -114,80 +132,7 @@ The first time you start Harmony, it will ask you to configure your PAT
 if you don\(cqt want to use the Environment variable.
 You only need one of (a) the ENV var and (b) the config property and the
 environment variable will take precedence if you have both set.
-.SS NPM
-You can install Harmony via npm directly by running
-\f[CR]npm install \-g \(atmattpolzin/harmony\f[R].
-.SS GitHub Release
-You can install any Harmony release by downloading the
-\f[CR]harmony\-npm.tar.gz\f[R] file from the GitHub Release page,
-unzipping it, and running \f[CR]npm install \-\-global\f[R].
-.SS Nix Flake
-You can add Harmony to your Flake inputs as follows:
-.IP
-.EX
-  inputs = {
-    ...
-    harmony.url = \(dqgithub:mattpolzin/harmony\(dq;
-    harmony.inputs.nixpkgs.follows = \(dqnixpkgs\(dq;
-  };
-.EE
 .PP
-Then, in your outputs, bring Harmony into a package install list as
-\f[CR]harmony.packages.<system>.harmony\f[R].
-.PP
-Harmony builds are cached in Cachix so you can take advantage of those
-builds by adding \f[CR]https://gh\-harmony.cachix.org\f[R] to the list
-of \f[CR]substituters\f[R] and
-\f[CR]gh\-harmony.cachix.org\-1:KX5tTtEt3Y6an8pywe3Cy6jR9bUo+1Cl7hJmh+5eI4I=\f[R]
-to the list of \f[CR]trusted\-public\-keys\f[R].
-.SS From Source
-The build script assumes a HEAD build of Idris 2 is installed on your
-system.
-For an alternative, see the Docker Build instructions below.
-.PP
-Build Harmony from source with a call to \f[CR]make\f[R].
-Then install it globally with \f[CR]make install\f[R].
-.SS Docker Build
-If you want to build Harmony without installing Idris 2 on your system,
-you can build Harmony within a Docker container and then install the
-resulting Javascript onto your system.
-.PP
-First, download the latest nightly Docker image:
-.IP
-.EX
-docker pull mattpolzin2/idris\-docker:nightly
-.EE
-.PP
-Then, from a directory containing this Harmony git repository, build
-Harmony:
-.IP
-.EX
-docker run \-\-rm \-v \(dq$(pwd):/build\(dq \(rs
-  mattpolzin2/idris\-docker:nightly \(rs
-  bash \-c \(dqapt\-get update && apt\-get install \-y git && cd /build && make\(dq
-.EE
-.PP
-At this point you are done with Docker.
-From the same directory, install Harmony globally:
-.IP
-.EX
-npm install \-\-global
-.EE
-.SS Bash completion
-Set up Bash completion by adding the following to your Bash resource
-file or profile:
-.IP
-.EX
-eval \(dq$(harmony \-\-bash\-completion\-script)\(dq
-.EE
-.SS Zsh completion
-Zsh completion is supported via \f[CR]bashcompinit\f[R] and can be
-loaded by adding the following to your Zsh resource file or profile:
-.IP
-.EX
-eval \(dq$(harmony \-\-zsh\-completion\-script)\(dq
-.EE
-.SS Usage
 The first time you start Harmony in any particular folder, you will be
 asked to provide some information about the GitHub repository you are
 working with.
@@ -223,13 +168,13 @@ Would you like harmony to comment when it requests reviewers? [Y/n]
 Would you like harmony to request team reviews in addition to individuals when it requests reviewers? [Y/n] 
 Creating config...
 .EE
-.PP
-Once configured, Harmony supports the following commands:
-\f[CR]config\f[R], \f[CR]branch\f[R], \f[CR]pr\f[R], \f[CR]quick\f[R],
-\f[CR]label\f[R], \f[CR]request\f[R] (also aliased to \f[CR]rq\f[R]),
-\f[CR]contribute\f[R], \f[CR]whoami\f[R], \f[CR]reflect\f[R],
-\f[CR]list\f[R], \f[CR]graph\f[R], \f[CR]health\f[R], and
-\f[CR]sync\f[R].
+.SS Usage
+Once configured, Harmony supports the following commands that are
+documented below: \f[CR]config\f[R], \f[CR]branch\f[R], \f[CR]pr\f[R],
+\f[CR]quick\f[R], \f[CR]label\f[R], \f[CR]request\f[R] (also aliased to
+\f[CR]rq\f[R]), \f[CR]contribute\f[R], \f[CR]whoami\f[R],
+\f[CR]reflect\f[R], \f[CR]list\f[R], \f[CR]graph\f[R],
+\f[CR]health\f[R], and \f[CR]sync\f[R].
 .PP
 \f[B]Note on color output:\f[R] Harmony uses colored output for some
 commands.
@@ -388,14 +333,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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mattpolzin/harmony",
-  "version": "5.8.0",
+  "version": "6.1.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"
   }
 }