Administrators
Installing the plugin
Project Creator for JIRA is available through the Atlassian Marketplace. Install it through the Universal Plugin Manager in JIRA.
Configuration of addon
In the administration area of Stash, click on Javascript Hooks to get to the global configuration area for Javascript Hooks for Stash. From this screen the administrator can configure the available hook actions to the script writers.
| Configuration item | Description | Default value |
|---|---|---|
| Script timeout | How long a script can run for before being stopped | 3000ms |
| Enable HTTP | Can the javascript make http calls to remote servers | Enabled |
| HTTP Connection timeout | 3000ms | |
| HTTP Socket timeout | 3000ms | |
| Enable external commands | Can the javascript shell out and execute a command on the command line as the stash user | Disabled |
| External command timeout | How long to wait for a command to run before attempting to kill it | 3000ms |
| Enable Email | Can the javascript trigger emails to be sent? | Enabled |
| Email subject prefix | A prefix for the subject line for any emails sent | None |
Enabling JS Hooks for a repository
The first time that a repository administrator opens the JS Hooks page for the repository they'll be prompted to enable JS Hooks for the repository. This will enable the repository hook automatically. If for some reason the Repository Hooks are disabled through the Hooks screen, the administrator will be repromted.
 |  |
Writing a Javascript hook
Writing a Javascript hook is quite simple. Simply click on "Add Hook" on the repository JS Hook page and you'll be presented with a screen for your editing. Each Hook will require a name and the script itself.
As part of the editing experience, you can select a changes (or a pull request in the case of a merge check) to run against. This will run your actual Javascript code against the particular item as if it was "live". At the end of the run you can see if there was an error with your code and which of the external api calls were called (and what the arguments passed to them were).
Once saved - the hook becomes active. At any point though, you can disable the hook from the repository view page.
