Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

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

will be shown "Enable" buttons that you click to enable one or more of the three available types of JS Hooks. Items enabled will only be enabled for that specific repository.

If for some reason a type of JS Hooks are disabled via this configuration screen, the administrator will be

repromted

shown the "Enable" buttons again for the specific JS Hooks not currently enabled.

Image Removed
Image Added
Image Removed

Image Added

Writing a

Javascript

JavaScript hook

Writing a

Javascript

JS hook

is

can be quite simple.

Simply click

 Click on "Add Hook" on the repository JS

Hook

hook page and you'll be presented with a configuration 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

. In this screen:

  1. Give the hook a name
  2. Add the script for the hook into the "Script code" area.
  3. Select a change (or pull request in case of a merge check) to run against
.
    1. This will run your actual
Javascript
    1. 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
  1. Click Save

The hook is now active.

At

 At any point though, you can disable the hook from the repository view page.

Image Removed

 

Image Added

Troubleshooting