| | |
|---|
| | |
|
|---|
| | | The Groovy hook mechanism allows for dynamic extension of Gitblit to execute custom tasks on receiving and processing push events. The scripts run within the context of your Gitblit instance and therefore have access to Gitblit's internals at runtime.
|
|---|
| | |
|
|---|
| | | Your Groovy scripts should be stored in the *groovy.scriptsFolder* as specified in `gitblit.properties` or `web.xml`.
|
|---|
| | | ### Rules & Requirements
|
|---|
| | | 1. Your Groovy scripts must be stored in the *groovy.scriptsFolder* as specified in `gitblit.properties` or `web.xml`.
|
|---|
| | | 2. All script files must have the *.groovy* extension. Because of this you may omit the extension when specifying the script.
|
|---|
| | | 3. Scripts must be explicitly specified to be executed, no scripts are *automatically* executed by name or extension.
|
|---|
| | | 4. A script can be specified to run on *all repositories* by adding the script file name to *groovy.preReceiveScripts* or *groovy.postReceiveScripts* in `gitblit.properties` or `web.xml`.
|
|---|
| | | 5. Scripts may also be specified per-repository in the repository's settings.
|
|---|
| | | 6. Global/shared scripts are executed first in their listed order, followed by per-repository scripts in their listed order.
|
|---|
| | | 7. A script may only be defined once in a pre-receive list and once in a post-receive list. |
|---|
| | | You may execute the same script on pre-receive and post-receive, just not multiple times within a pre-receive or post-receive event.
|
|---|
| | | 8. Gitblit does not differentiate between what can be a pre-receive script and what can be a post-receive script.
|
|---|
| | | 9. If a script *returns false* then the hook chain is aborted and none of the subsequent scripts will execute.
|
|---|
| | |
|
|---|
| | | Scripts must be explicitly specified to be executed. A script can be run on *all repositories* by adding the script file name to *groovy.preReceiveScripts* or *groovy.postReceiveScripts* in `gitblit.properties` or `web.xml`. Alternatively, you may specify per-repository scripts in the repository settings. Global/shared scripts are executed first in their listed order, followed by per-repository scripts in their listed order.
|
|---|
| | |
|
|---|
| | | Some primitive sample scripts are included in the GO and WAR distributions to show you how you can tap into Gitblit with the provided bound variables. |
|---|
| | | Some sample scripts are included in the GO and WAR distributions to show you how you can tap into Gitblit with the provided bound variables. Additional implementation details may be specified in the header comment of these examples. |
|---|
| | | Hook contributions and improvements are welcome.
|
|---|
| | |
|
|---|
| | | ### Pre-Receive
|
|---|
| | |
|
|---|
| | | Pre-Receive scripts execute after the pushed objects have all been written to the Git repository but before the refs have been updated to point to these new objects.
|
|---|
| | |
|
|---|
| | | This is the appropriate point to block a push and is how many Git tools implement branch-write permissions.
|
|---|
| | |
|
|---|
| | | ### Post-Receive
|
|---|
| | |
|
|---|
| | | Post-Receive scripts execute after all refs have been updated.
|
|---|
| | |
|
|---|
| | | This is the appropriate point to trigger continuous integration builds or send email notifications, etc.
|
|---|
| | |
|
|---|
| | | ## Client Setup and Configuration
|
|---|
| | | ### Https with Self-Signed Certificates
|
|---|
| | | You must tell Git/JGit not to verify the self-signed certificate in order to perform any remote Git operations.
|
|---|
