@mattpolzin/harmony 4.4.0 → 5.1.0

package/README.md

@@ -47,7 +47,7 @@ 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
+adding `https://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`.
 
@@ -124,7 +124,7 @@ Not all configuration properties can be read/set with this command.
 #### Properties
 - `requestTeams` (`true`/`false`) -- When picking a reviewer from a team, request the team as a reviewer as well.
 - `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.
+- `commentOnRequest` (`none`/`name`/`at-mention`) -- When requesting a reviewer chosen by Harmony, comment on the pull request or not.
 - `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.
@@ -136,7 +136,7 @@ Running `harmony branch` will print the URI for accessing the currently checked
 Many operating systems have an `open` command (though the name "open" is not ubiquitous); this means you can run something like `open $(harmony branch)` to open a web browser to the current branch on GitHub.
 
 ### PR
-Running `harmony pr [--draft] [#<label>, ...]` 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 PRs can be created as drafts by specifying the `--draft` flag with the `pr` command.
+Running `harmony pr [--draft] [#<label>, ...]` 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 `--draft` flag with the `pr` command.
 
 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 description for the PR. If you have an `EDITOR` environment variable set, Harmony will use that editor to get the PR description from you. If you have a PR template at `.github/PULL_REQUEST_TEMPLATE.md`, Harmony will also preload that into your editor. If you do not have an `EDITOR` environment variable set, you will still be able to enter a description from the command line but PR templates are only supported when an `EDITOR` is specified.
 
@@ -144,6 +144,17 @@ You can also specify any number of labels to apply by prefixing them with '#'. F
 
 Many operating systems have an `open` command (though the name "open" is not ubiquitous); this means you can run something like `open $(harmony pr)` to open a web browser to an existing PR for the current branch.
 
+#### Examples
+Create a draft pull request for the current branch:
+```shell
+harmony pr --draft
+```
+
+Create a PR for the current branch and add the `urgent` label:
+```shell
+harmony pr #urgent
+```
+
 ### Label
 Running `harmony label {<label>} [...]` will help you create a PR if one does not exist yet and then it will apply the given labels to the PR. This is essentially an alias for the `harmony pr` command but without support for creating draft PRs.
 
@@ -195,6 +206,8 @@ You can simultaneously get the URI for a PR to review and checkout the branch ne
 
 Many operating systems have an `open` command (though the name "open" is not ubiquitous); this means you can run something like `open $(harmony contribute)` to open a web browser to the PR that Harmony is suggesting.
 
+You can also run `harmony contribute --list` if you want to list out a few PRs to consider reviewing them instead of choosing just one PR to look into and printing that PRs URI.
+
 #### Examples
 Retrieve a URI for the oldest unreviewed and open PR (prioritizing PRs for which you are a requested reviewer):
 ```shell