@mattpolzin/harmony 6.3.1 → 6.5.0

package/README.md

@@ -46,16 +46,14 @@ installed with flakes enabled, you can run it as
 `nix run github:mattpolzin/harmony`.
 
 ### Build time
-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.
-
-Alternatively, you can build Harmony with Docker (see 
-[Docker Build](#docker-build)).
+Harmony can be built with `nix` or using `make` which in turn requires you have
+the `pack` Idris2 package manager installed.
 
+Building the latest commits of Harmony is only tested to work against the latest
+package collection but may work from one that is sufficiently recent as well.
 ### Testing
-Tests can be run with `make test`. You'll need a few common tools in your `PATH`
-to run all the tests:
+Tests can be run with `make test`. You'll need a few common tools (in addition
+to the tools required to build harmony) in your `PATH` to run all the tests:
   - `realpath`
   - `sed`
   - `xargs`
@@ -91,35 +89,12 @@ adding `https://gh-harmony.cachix.org` to the list of `substituters` and
 list of `trusted-public-keys`.
 
 ### From Source
-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.
+The build script assumes `pack` with a recent version of the package collection
+is installed on your system.
 
 Build Harmony from source with a call to `make`. Then install it globally with
 `make install`.
 
-### Docker Build
-If you want to build Harmony without installing Idris 2 on your system, you can
-build Harmony within a Docker container and then install the resulting
-Javascript onto your system.
-
-First, download the latest nightly Docker image:
-```shell
-docker pull mattpolzin2/idris-docker:nightly
-```
-
-Then, from a directory containing this Harmony git repository, build Harmony:
-```shell
-docker run --rm -v "$(pwd):/build" \
-  mattpolzin2/idris-docker:nightly \
-  bash -c "apt-get update && apt-get install -y git && cd /build && make"
-```
-
-At this point you are done with Docker. From the same directory, install Harmony
-globally:
-```shell
-npm install --global
-```
-
 ## Bash completion
 Set up Bash completion by adding the following to your Bash resource file or
 profile:
@@ -227,6 +202,12 @@ Not all configuration properties can be read/set with this command.
 `branchParsing` (`none`/`jira`/`github`) 
 : Optionally extract a Jira ticket slug or GitHub issue number from the branch name and prepend it to the PR title or body to link the PR and ticket/issue.
 
+`bugfixPRTitlePrefix` (optional string) 
+: A string to prefix default PR titles with when the branch the PR is being created from is determined to be a bugfix branch (branch name starts with 'bugfix'). For example, a common prefix is '[fix]'.
+
+`addPrTreeDescription` (`true`/`false`)
+: Determines whether to add a tree of PRs to the description for any PR that is into a branch other than the `mainBranch` configured.
+
 `defaultRemote` (optional string) 
 : When pushing new branches, what remote destination should be used.
 
@@ -329,13 +310,16 @@ organization.
 
 Running `harmony list <team>` will list the members of the given GitHub Team.
 
-## `pr [--draft | --ready] [-i/--into {<branch-name>}] [#label, ...]`
+## `pr [--draft | --ready] [-i/--into {<branch-name>}] [--print-tree] [#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 or they can be marked as ready for review with the `--ready`
-flag. The default behavior for new PRs is to mark them ready.
+used to view the PR. If there is not a PR, Harmony will help you create one. The
+`--print-tree` flag will print a tree of PRs for branches between the current
+one and the `mainBranch` of the repository instead of just printing the URI for
+the current branch's PR. New and existing PRs can be marked as drafts by
+specifying the `--draft` flag with the `pr` command or they can be marked as
+ready for review with the `--ready` flag. The default behavior for new PRs is to
+mark them ready.
 
 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