Skip to content

Commit

Permalink
fix: correct the installation docs to make the plugin executable
Browse files Browse the repository at this point in the history
  • Loading branch information
rholshausen committed May 16, 2022
1 parent eb38ca2 commit 8f7956c
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,14 @@ a request to [support@pactflow.io](support@pactflow.io) with the details.

### Installing the plugin
To install the plugin requires the plugin executable binary as well as the plugin manifest file to be unpacked/copied into
a Pact plugin directory. By default, this will be `.pact/plugins/protobuf-<version>` in the home directory (i.e. `$HOME/.pact/plugins/protobuf-0.1.3`).

Example installation of Linux version 0.1.3:
1. Create the plugin directory if needed: `mkdir -p ~/.pact/plugins/protobuf-0.0.3`
2. Download the plugin manifest into the directory: `wget https://github.com/pactflow/pact-protobuf-plugin/releases/download/v-0.1.3/pact-plugin.json -O ~/.pact/plugins/protobuf-0.1.3/pact-plugin.json`
3. Download the plugin executable into the directory: `wget https://github.com/pactflow/pact-protobuf-plugin/releases/download/v-0.1.3/pact-protobuf-plugin-linux-x86_64.gz -O ~/.pact/plugins/protobuf-0.1.3/pact-protobuf-plugin-linux-x86_64.gz`
4. Unpack the plugin executable: `gunzip -N ~/.pact/plugins/protobuf-0.1.3/pact-protobuf-plugin-linux-x86_64.gz`
a Pact plugin directory. By default, this will be `.pact/plugins/protobuf-<version>` in the home directory (i.e. `$HOME/.pact/plugins/protobuf-0.1.5`).

Example installation of Linux version 0.1.3 (replace with the actual version you are using):
1. Create the plugin directory if needed: `mkdir -p ~/.pact/plugins/protobuf-0.1.5`
2. Download the plugin manifest into the directory: `wget https://github.com/pactflow/pact-protobuf-plugin/releases/download/v-0.1.5/pact-plugin.json -O ~/.pact/plugins/protobuf-0.1.3/pact-plugin.json`
3. Download the plugin executable into the directory: `wget https://github.com/pactflow/pact-protobuf-plugin/releases/download/v-0.1.5/pact-protobuf-plugin-linux-x86_64.gz -O ~/.pact/plugins/protobuf-0.1.5/pact-protobuf-plugin.gz`
4. Unpack the plugin executable: `gunzip -N ~/.pact/plugins/protobuf-0.1.5/pact-protobuf-plugin.gz`
5. Make the plugin executable: `chmod +x ~/.pact/plugins/protobuf-0.1.5/pact-protobuf-plugin`

**Note:** The unpacked executable name must match the `entryPoint` value in the manifest file. By default, this is
`pact-protobuf-plugin` on unix* and `pact-protobuf-plugin.exe` on Windows.
Expand Down

0 comments on commit 8f7956c

Please sign in to comment.