Nosial/ncc
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases 13 Packages Wiki Activity Actions 2

Added documentation regarding installer

Browse source
This commit is contained in:
Netkas 2023-01-29 15:30:49 -05:00
parent 4484200bb7
commit 74b356867f
1 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
DOCUMENTATION.md
View file

@ -36,6 +36,7 @@ NCC, from basic installation, basic usage, standards and much more.
* [execution_policy.execute](#executionpolicyexecute)
* [execution_policy.exit_handlers](#executionpolicyexithandlers)
* [exit_handler](#exithandler)
* [installer](#installer)
* [Execution Policies](#execution-policies)
* [Supported Runners](#supported-runners)
* [Configuring Runners](#configuring-runners)
@ -435,6 +436,22 @@ running.
| run | `string` | No | The name of the execution policy to run when this exit handler is triggered. |
| exit_code | `int` | No | The exit code that the process must have exited with for this exit handler to be triggered. |
### installer
The `installer` field contains allows you to configure the execution of policies during different stages of the
installation process of the package. Note that these files only accepts an array of strings, which are the names of
the execution policies that you want to run during the specified stage. NCC will reject the package if the execution
policy does not exist.
| Name | Type | Required | Description |
|----------------|------------|----------|-------------------------------------------------------------------------|
| pre_install | `string[]` | No | The execution policies to run before the installation of the package. |
| post_install | `string[]` | No | The execution policies to run after the installation of the package. |
| pre_uninstall | `string[]` | No | The execution policies to run before the uninstallation of the package. |
| post_uninstall | `string[]` | No | The execution policies to run after the uninstallation of the package. |
| pre_update | `string[]` | No | The execution policies to run before the update of the package. |
| post_update | `string[]` | No | The execution policies to run after the update of the package. |
------------------------------------------------------------------------------------
# Execution Policies