@mattpolzin/harmony 4.0.1 → 4.3.0

package/README.md

@@ -46,6 +46,11 @@ You can add Harmony to your Flake inputs as follows:
 
 Then, in your outputs, bring Harmony into a package install list as `harmony.packages.<system>.harmony`.
 
+Harmony builds are cached in Cachix so you can take advantage of those builds by
+adding `gh-harmony.cachix.org` to the list of `substituters` and
+`gh-harmony.cachix.org-1:KX5tTtEt3Y6an8pywe3Cy6jR9bUo+1Cl7hJmh+5eI4I=` to the
+list of `trusted-public-keys`.
+
 ### From Source
 The build script assumes a HEAD build of Idris 2 is installed on your system. For an alternative, see the [Docker Build](#docker-build) instructions below.
 
@@ -107,7 +112,10 @@ Would you like harmony to request team reviews in addition to individuals when i
 Creating config...
 ```
 
-Once configured, Harmony supports the following commands: `config`, `branch`, `pr`, `label`, `request`, `contribute`, `whoami`, `reflect`, `list`, `graph`, `health`, and `sync`.
+Once configured, Harmony supports the following commands: `config`, `branch`, `pr`, `label`, `request` (also aliased to `rq`), `contribute`, `whoami`, `reflect`, `list`, `graph`, `health`, and `sync`.
+
+**Note on color output:**
+Harmony uses colored output for some commands. You can adjust these colors slightly with the `theme` configuration option. You can also use the `NO_COLOR` environment variable to disable all colored output. Lastly, Harmony will avoid colored output when it determines `stdout` is not a TTY device (as is the case for e.g. redirecting harmony output into a file or piping into `cat`: `harmony ... | cat`).
 
 ### Config
 Running `harmony config <property>` will read the given configuration property. `harmony config <property> <value>` will set the configuration property.
@@ -118,6 +126,8 @@ Not all configuration properties can be read/set with this command.
 - `requestUsers` (`true`/`false`) -- When requesting a team as a reviewer, pick a user to review as well.
 - `commentOnRequest` (`true`/`false`) -- When requesting a reviewer chosen by Harmony, comment on the pull request.
 - `defaultRemote` (optional string) -- When pushing new branches, what remote destination should be used.
+- `mainBranch` (optional string) -- When creating a PR, this is the default base branch.
+- `theme` (`dark`/`light`) -- Use colors suited better for either a dark or light Terminal background.
 - `githubPAT` (optional string) -- If the `$GITHUB_PAT` environment variable is not set, this Personal Access Token is used to authenticate with GitHub.
 
 ### Branch
@@ -142,6 +152,8 @@ Note that labels are _not_ prefixed with '#' for this command. There is no need
 ### Request
 Running `harmony request {<team> | +<user>} [#<label>] [...]` will help you create a PR if one does not exist yet and then it will request reviews from teams and/or users.
 
+There is also a `harmony rq` alias for `harmony request`.
+
 If `harmony config requestUsers` is `True` (defualt) then harmony will pick someone to review the PR (from one of the listed teams). If `harmony config requestTeams` is `True` (default) then harmony will request reviews from the teams you listed. If `harmony config commentOnRequest` is `True` then harmony will comment on the Pull Request indicating that teams & users were "harmoniously requested" -- this comment will @mention requested users so it may be useful or annoying depending on the requested user's GitHub notification settings.
 
 You can also require that specific additional users (on top of the one Harmony will pick for you) are requested to review the PR. You do this by specifying those users' logins prefixed with '+' as arguments to Harmony. This will request review from those specific additional users regardless of the `requestUsers` setting; that setting controls whether Harmony picks users from each Team you specify to review PRs.