Skip to content

Commit

Permalink
Update run config section
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastianfeldmann committed Oct 10, 2023
1 parent 7a8c30f commit a65fb26
Showing 1 changed file with 31 additions and 19 deletions.
50 changes: 31 additions & 19 deletions configure.html
Original file line number Diff line number Diff line change
Expand Up @@ -393,12 +393,15 @@ <h2>Settings</h2>
"includes-level": 2,
"includes": [],
"plugins": [],
"run-mode": "docker",
"run-exec": "docker exec -i CONTAINER_NAME",
"run-path": "vendor/bin/captainhook",
"php-path": "/usr/bin/php7.4"
"php-path": "/usr/bin/php7.4",
"custom": {
"my-custom-index": "my-custom-value"
},
"run": {
"mode": "docker",
"exec": "docker exec -i CONTAINER_NAME",
"path": "vendor/bin/captainhook",
"git": "/docker/.git"
}
}
}</code></pre>
Expand Down Expand Up @@ -457,33 +460,39 @@ <h2>Settings</h2>
<td>-</td>
</tr>
<tr>
<td>run-mode</td>
<td>CaptainHook execution mode (local|docker)</td>
<td>local</td>
<td>php-path</td>
<td>Path to the PHP executable</td>
<td>-</td>
</tr>
<tr>
<td>run-exec</td>
<td>Docker command to spin up the container and execute a script</td>
<td>custom</td>
<td>List of custom settings you need for replacements or custom actions</td>
<td>-</td>
</tr>
<tr><td colspan="3"><strong>Run Configuration</strong></td></tr>
<tr>
<td>mode</td>
<td>CaptainHook execution mode (shell|php|local|docker)</td>
<td>shell</td>
</tr>
<tr>
<td>run-path</td>
<td>Path to the command inside your docker container</td>
<td>exec</td>
<td>Docker command to spin up the container and execute a script</td>
<td>-</td>
</tr>
<tr>
<td>php-path</td>
<td>Path to the PHP executable</td>
<td>path</td>
<td>Path to the CaptainHook command inside your Docker container</td>
<td>-</td>
</tr>
<tr>
<td>custom</td>
<td>List of custom settings you need for replacements or custom actions</td>
<td>git</td>
<td>Absolute path to the .git directory inside your Docker container</td>
<td>-</td>
</tr>
</table>

<a name="settings-overwrite"></a>
<a id="settings-overwrite"></a>
<h3>Overwrite settings</h3>
<p>
If you have different preferences as your team does and you want to tweak some settings to your needs but you
Expand All @@ -501,9 +510,12 @@ <h3>Overwrite settings</h3>
"verbosity": "quiet",
"ansi-colors": false,
"fail-on-first-error": false,
"run-mode": "docker",
"run-exec": "docker exec -i MY_CONTAINER_NAME",
"run-path": "vendor/bin/captainhook",
"run": {
"mode": "docker",
"exec": "docker exec -i MY_CONTAINER_NAME",
"path": "vendor/bin/captainhook",
"git": "/docker/.git"
},
"custom": {
"some-key": "some value"
}
Expand Down

0 comments on commit a65fb26

Please sign in to comment.