@mattpolzin/harmony 4.3.0 → 5.0.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 +6 -2
- package/harmony +1364 -1066
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -89,7 +89,7 @@ eval "$(harmony --zsh-completion-script)"
|
|
|
89
89
|
## Usage
|
|
90
90
|
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. This information is stored in a file named `harmony.json` in the current working directory.
|
|
91
91
|
|
|
92
|
-
Note that the GitHub organization and repository are both slugs, not names. These are the values you find in a GitHub URL pointing to your repository. Harmony
|
|
92
|
+
Note that the GitHub organization and repository are both slugs, not names. These are the values you find in a GitHub URL pointing to your repository. Harmony works with personal repositories but some of Harmony's features are not available for these repos because they do not have teams or members.
|
|
93
93
|
```
|
|
94
94
|
$ harmony sync
|
|
95
95
|
Creating a new configuration (storing in harmony.json)...
|
|
@@ -124,7 +124,7 @@ Not all configuration properties can be read/set with this command.
|
|
|
124
124
|
#### Properties
|
|
125
125
|
- `requestTeams` (`true`/`false`) -- When picking a reviewer from a team, request the team as a reviewer as well.
|
|
126
126
|
- `requestUsers` (`true`/`false`) -- When requesting a team as a reviewer, pick a user to review as well.
|
|
127
|
-
- `commentOnRequest` (`
|
|
127
|
+
- `commentOnRequest` (`none`/`name`/`at-mention`) -- When requesting a reviewer chosen by Harmony, comment on the pull request or not.
|
|
128
128
|
- `defaultRemote` (optional string) -- When pushing new branches, what remote destination should be used.
|
|
129
129
|
- `mainBranch` (optional string) -- When creating a PR, this is the default base branch.
|
|
130
130
|
- `theme` (`dark`/`light`) -- Use colors suited better for either a dark or light Terminal background.
|
|
@@ -195,6 +195,8 @@ You can simultaneously get the URI for a PR to review and checkout the branch ne
|
|
|
195
195
|
|
|
196
196
|
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.
|
|
197
197
|
|
|
198
|
+
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.
|
|
199
|
+
|
|
198
200
|
#### Examples
|
|
199
201
|
Retrieve a URI for the oldest unreviewed and open PR (prioritizing PRs for which you are a requested reviewer):
|
|
200
202
|
```shell
|
|
@@ -230,6 +232,8 @@ Running `harmony reflect` will show a summary of your review requests and author
|
|
|
230
232
|
|
|
231
233
|
|
|
232
234
|
### List
|
|
235
|
+
Running `harmony list` will list all the teams for the configured GitHub organization.
|
|
236
|
+
|
|
233
237
|
Running `harmony list <team>` will list the members of the given GitHub Team.
|
|
234
238
|
|
|
235
239
|
### Graph
|