@mattpolzin/harmony 5.0.0 → 5.2.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 +15 -2
- package/harmony +1867 -1728
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -47,7 +47,7 @@ You can add Harmony to your Flake inputs as follows:
|
|
|
47
47
|
Then, in your outputs, bring Harmony into a package install list as `harmony.packages.<system>.harmony`.
|
|
48
48
|
|
|
49
49
|
Harmony builds are cached in Cachix so you can take advantage of those builds by
|
|
50
|
-
adding `gh-harmony.cachix.org` to the list of `substituters` and
|
|
50
|
+
adding `https://gh-harmony.cachix.org` to the list of `substituters` and
|
|
51
51
|
`gh-harmony.cachix.org-1:KX5tTtEt3Y6an8pywe3Cy6jR9bUo+1Cl7hJmh+5eI4I=` to the
|
|
52
52
|
list of `trusted-public-keys`.
|
|
53
53
|
|
|
@@ -136,14 +136,27 @@ Running `harmony branch` will print the URI for accessing the currently checked
|
|
|
136
136
|
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.
|
|
137
137
|
|
|
138
138
|
### PR
|
|
139
|
-
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
|
|
139
|
+
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.
|
|
140
140
|
|
|
141
141
|
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.
|
|
142
142
|
|
|
143
143
|
You can also specify any number of labels to apply by prefixing them with '#'. For example, `harmony pr #backport #bugfix` would create a PR and apply the `backport` and `bugfix` labels.
|
|
144
144
|
|
|
145
|
+
If you are using harmony from a script or some other environment without TTY support, harmony will print a GitHub URL that can be used to create the PR. This mode of operation will ignore the `--draft` and `#label` options.
|
|
146
|
+
|
|
145
147
|
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.
|
|
146
148
|
|
|
149
|
+
#### Examples
|
|
150
|
+
Create a draft pull request for the current branch:
|
|
151
|
+
```shell
|
|
152
|
+
harmony pr --draft
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
Create a PR for the current branch and add the `urgent` label:
|
|
156
|
+
```shell
|
|
157
|
+
harmony pr #urgent
|
|
158
|
+
```
|
|
159
|
+
|
|
147
160
|
### Label
|
|
148
161
|
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.
|
|
149
162
|
|