@mattpolzin/harmony 1.3.0 → 2.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.
- harmony-npm/README.md +6 -3
- harmony-npm/harmony +4048 -4134
- harmony-npm/package.json +3 -3
harmony-npm/README.md
CHANGED
|
@@ -4,7 +4,7 @@ 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 only requires NodeJS
|
|
7
|
+
Running Harmony only requires NodeJS 14+ (and a local installation of `git`).
|
|
8
8
|
### Build time
|
|
9
9
|
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
10
|
|
|
@@ -30,7 +30,7 @@ You can install Harmony via npm directly by running `npm install -g @mattpolzin/
|
|
|
30
30
|
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
31
|
|
|
32
32
|
### From Source
|
|
33
|
-
The
|
|
33
|
+
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
34
|
|
|
35
35
|
Build Harmony from source with a call to `make`. Then install it globally with `make install`.
|
|
36
36
|
|
|
@@ -91,7 +91,7 @@ Would you like harmony to assign teams in addition to individuals when it assign
|
|
|
91
91
|
Creating config...
|
|
92
92
|
```
|
|
93
93
|
|
|
94
|
-
Once configured, Harmony supports the following commands: `branch`, `pr`, `assign`, `contribute`, `whoami`, `reflect`, `list`, `graph`, `config`, and `sync`.
|
|
94
|
+
Once configured, Harmony supports the following commands: `branch`, `pr`, `label`, `assign`, `contribute`, `whoami`, `reflect`, `list`, `graph`, `config`, and `sync`.
|
|
95
95
|
|
|
96
96
|
### Branch
|
|
97
97
|
Running `harmony branch` will print the URI for accessing the currently checked out branch on GitHub.
|
|
@@ -105,6 +105,9 @@ If you need to create a PR still, you will be prompted for a branch to open the
|
|
|
105
105
|
|
|
106
106
|
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.
|
|
107
107
|
|
|
108
|
+
### Label
|
|
109
|
+
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.
|
|
110
|
+
|
|
108
111
|
### Assign
|
|
109
112
|
Running `harmony assign {<team> | +<user>} [...]` will help you create a PR if one does not exist yet and then it will pick someone to review the PR (from one of the listed teams) and assign both that user and the teams you listed as reviewers of the PR.
|
|
110
113
|
|