Chapter 16. Repository hooks
In Decision Central, you can use scripts, known as hooks, to configure the repository to trigger a specified action every time a particular event happens.
16.1. Configuring git hooks
Decision Central can automatically push changes to a remote repository using Git hooks. After you configure the post-commit hook, Decision Central automatically pushes your changes to the remote repository.
Currently only post-commit hooks are supported. Post-commit hooks are triggered after the commit process finishes.
Prerequisites
- Red Hat Decision Manager projects exist in an external Git repository.
- Credentials required for read access to that external Git repository are available.
Procedure
- Log in to Decision Central.
-
Select Menu
Projects. - Select or create the space into which you want to import the projects.
-
Click
on the right side of the screen and select Import Project.
In the Import Project window, enter the URL (for example,
https://github.com/USERNAME/REPOSITORY_NAME.git) and credentials for the Git repository that contains the project that you want to import and click Import.The project is added to the Decision Central Git repository and is available in the created or default space.
ImportantUse the HTTPS or Git protocol instead of a SCP-style SSH URL. Decision Central does not support the basic SSH URL and an error appears if you use this URL.
In a terminal window, change to the created repository.
cd JBOSS_HOME/bin/.niogit/REPOSITORY_NAME.git
Create the
post-commitfile in theJBOSS_HOME/bin/.niogit/REPOSITORY_NAME.git/hooksdirectory, set the permissions torwxr—r--and add the following content:#!/bin/sh git push origin master
Make sure that the configuration was successful by creating a new guided rule in Decision Central:
-
Select Menu
Projects Add Asset Guided Rule. - Fill in the required information in the displayed Create new Guided Rule window.
Click Ok.
Decision Central automatically pushes all changes to the remote repository.
-
Select Menu
You can also specify the org.uberfire.nio.git.hooks system property. Specify a directory with default hook files as the value for this property. This directory will be copied to the newly created Git repositories. See the following example of a standalone.xml file with this setting below:
<system-properties> <property name="org.uberfire.nio.git.hooks" value="/opt/jboss-as/git-hooks"> </property> ... </system-properties>
Additional resources
16.2. Git hook exit codes
When a git hook exits an integer value is returned which determines the status of the git hook execution. This integer value is known as a git hook exit code. The execution status can be a success, warning or failure.
16.2.1. Types of exit codes
Decision Central has the following three types of exit codes:
Successful notification
0: Success. A git hook that exits with code 0 displays a success notification in the user interface.
Warning notification
1..30: Warning. A git hook that exits with a code between 1 and 30 (inclusive) will display a warning notification in user interface.
Error notification
Anything else: Error. Any other code number will be displayed as an error notification.
UNIX systems only support error codes between 0 (success) and 255 (error). Any exit code outside of this range is converted to a different code which might result in displaying a wrong notification message. Windows systems don’t have this limitation and can support a wide range of exit codes.
16.3. Customizing git hook notifications
Decision Central provides a mechanism that enables users to receive feedback about git hook executions using customized messages based on a hook’s exit code.
Procedure
To enable notifications, in the
standalone.xmlfile set theappformer.git.hooks.bundlesystem property to point to a*.propertiesfile containing the custom messages for each exit code.For example:
<system-properties> <property name="appformer.git.hooks.bundle" value="/opt/jboss-as/git-hooks-messages/Messages.properties"> </property> ... </system-properties>
To display the messages, each line of the
*.propertiesmust have the following format:<exit_code>=<display_message>where,
<exit_code>is the git hook exit code and<display_message>is the custom message that is displayed to a user.Exit code messages with this format appear similar to the following example:
0=Success 1=Display Message 1 . . 31=Display Message 31
Its not necessary to define all the possible exit codes in the *.properties file. Notifications appear only for the exit codes defined in the *.properties file.
16.3.1. Internationalize git hook notifications
You can internationalize the notification messages by placing different *.properties files in the directory specified for the appformer.git.hooks.bundle system property. The names of the localized files have the format <filename>_<lang>.properties. These files must contain the same entries as in the original file.
For example, you have specified the system property to point to Messages.properties. Now you can create localized message properties files like Messages_en.properties for English, Messages_fr.properties for French, Messages_it.properties for Italian, and so on. The notification service will choose the one based on the user language and if there are no available translations for a language then it will use the default ones specified in the Messages.properties file.
The notification service only supports the ISO 8859-1 (LATIN 1) character set in the *.properties file. If you want to use extended characters, please escape them using their Unicode code.
