@mattpolzin/harmony 1.2.0 → 1.3.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 +10 -0
- harmony-npm/harmony +2377 -1763
- harmony-npm/package.json +1 -1
harmony-npm/README.md
CHANGED
|
@@ -13,6 +13,14 @@ Alternatively, you can build Harmony with Docker (see [Docker Build](#docker-bui
|
|
|
13
13
|
## Installation
|
|
14
14
|
For any installation, you need to have a GitHub [Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token).
|
|
15
15
|
|
|
16
|
+
Your Personal Access Token should have the following permissions:
|
|
17
|
+
- `repo` (Full control of private repositories)
|
|
18
|
+
- `read:org` (Read org and team membership, read org projects)
|
|
19
|
+
- `read:user`
|
|
20
|
+
- `user:email`
|
|
21
|
+
- `read:discussion`
|
|
22
|
+
- `read:enterprise` (Read enterprise profile data)
|
|
23
|
+
|
|
16
24
|
You can eiher add the PAT to your environment as the `GITHUB_PAT` variable (perhaps exporting it from your shell resource file or profile) or you can store your PAT in Harmony's config file. The first time you start Harmony, it will ask you to configure your PAT if you don't want to use the Environment variable. You only need one of (a) the ENV var and (b) the config property and the environment variable will take precedence if you have both set.
|
|
17
25
|
|
|
18
26
|
### NPM
|
|
@@ -155,6 +163,8 @@ Running `harmony list <team>` will list the members of the given GitHub Team.
|
|
|
155
163
|
### Graph
|
|
156
164
|
Running `harmony graph <team>` will graph the relative review workload of each of the members of the given GitHub Team.
|
|
157
165
|
|
|
166
|
+
You can optionally graph completed PR reviews with the `--completed` flag as well, though these are not considered for Harmony's weighting algorithm for review workload.
|
|
167
|
+
|
|
158
168
|
### Config
|
|
159
169
|
Running `harmony config <property>` will read the given configuration property. `harmony config <property> <value>` will set the configuration property.
|
|
160
170
|
|