From 124b4d3d1b33c516f17f65aa2da6533077d92d9d Mon Sep 17 00:00:00 2001 From: Joris Conijn Date: Sun, 20 Feb 2022 19:01:58 +0100 Subject: [PATCH] docs: remove deprecated command We prefer the `git pr` syntax over calling the executable directly. For this reason we remove the references to the executable. --- README.md | 20 ++------------------ 1 file changed, 2 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 50f6cb1..999a6cb 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,8 @@ source .venv/bin/activate pip install pull-request-codecommit ``` +You need to add the `.venv/bin/` path to your system `PATH`. This is needed for the `git pr` commands to function. + ## Configuration The tool uses the following file `~/.aws/pull-request-codecommit`. It will first load the `default` profile and then, if @@ -52,12 +54,6 @@ branch=develop To use `pull-request-codecommit` you just execute the following command: -```bash -pull-request-codecommit -``` - -Or: - ```bash git pr ``` @@ -66,12 +62,6 @@ git pr In some cases it makes sense to directly merge the pull request, in those cases you can use: -```bash -pull-request-codecommit --auto-merge -``` - -Or: - ```bash git pr --auto-merge ``` @@ -94,12 +84,6 @@ When a pull requests exists a proposal is made to update the existing pull reque When you want to overwrite the target branch you need to supply the `--branch ` option: -```bash -pull-request-codecommit --branch my-target-branch -``` - -Or: - ```bash git pr --branch my-target-branch ```