@mattpolzin/harmony 2.6.0 → 2.6.2
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 +19 -2
- package/harmony +2088 -2876
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,7 +4,10 @@ Harmony is a small tool that helps teams keep GitHub reviews running smoothly. I
|
|
|
4
4
|
|
|
5
5
|
## Dependencies
|
|
6
6
|
### Runtime
|
|
7
|
-
Running Harmony
|
|
7
|
+
Running Harmony requires NodeJS 14+ (and a local installation of `git`) or alternatively Nix with flakes enabled.
|
|
8
|
+
|
|
9
|
+
If you'd like to try Harmony out without even "installing" it and you have Nix installed with flakes enabled, you can run it as `nix run github:mattpolzin/harmony`.
|
|
10
|
+
|
|
8
11
|
### Build time
|
|
9
12
|
Building the latest commits of Harmony requires a HEAD build of the Idris 2 compiler. Each release page also indicates the version of Idris 2 that particular release will build against.
|
|
10
13
|
|
|
@@ -29,6 +32,18 @@ You can install Harmony via npm directly by running `npm install -g @mattpolzin/
|
|
|
29
32
|
### GitHub Release
|
|
30
33
|
You can install any Harmony release by downloading the `harmony-npm.tar.gz` file from the GitHub Release page, unzipping it, and running `npm install --global`.
|
|
31
34
|
|
|
35
|
+
### Nix Flake
|
|
36
|
+
You can add Harmony to your Flake inputs as follows:
|
|
37
|
+
```nix
|
|
38
|
+
inputs = {
|
|
39
|
+
...
|
|
40
|
+
harmony.url = "github:mattpolzin/harmony";
|
|
41
|
+
harmony.inputs.nixpkgs.follows = "nixpkgs";
|
|
42
|
+
};
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Then, in your outputs, bring Harmony into a package install list as `harmony.packages.<system>.harmony`.
|
|
46
|
+
|
|
32
47
|
### From Source
|
|
33
48
|
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.
|
|
34
49
|
|
|
@@ -155,7 +170,7 @@ harmony assign web +carl001 +emmaham
|
|
|
155
170
|
```
|
|
156
171
|
|
|
157
172
|
### Contribute
|
|
158
|
-
Running `harmony contribute` will print the URI of the oldest PR waiting for your review. If you are not requested for review on any PRs, Harmony will suggest a PR that you are not assigned to.
|
|
173
|
+
Running `harmony contribute` will print the URI of the oldest non-draft PR waiting for your review. If you are not requested for review on any PRs, Harmony will suggest a PR that you are not assigned to.
|
|
159
174
|
|
|
160
175
|
You can skip PRs and retrieve the next-oldest one by passing a dash followed by the number to skip (e.g. `-2` to skip the two oldest waiting PRs).
|
|
161
176
|
|
|
@@ -197,6 +212,8 @@ Running `harmony whoami` will print information about the currently configured a
|
|
|
197
212
|
### Reflect
|
|
198
213
|
Running `harmony reflect` will show a summary of your review requests and authored pull requests.
|
|
199
214
|
|
|
215
|
+
|
|
216
|
+
|
|
200
217
|
### List
|
|
201
218
|
Running `harmony list <team>` will list the members of the given GitHub Team.
|
|
202
219
|
|