Chapter 18. Repository hooks

Procedure

1. In Business Central, go to Menu Projects.
2. Select or create the space that you want to import the Git projects into.
3. Click on the right side of the screen and select Import Project.
4. In the Import Project window, enter the URL of your Git repository, for example, https://github.com/USERNAME/REPOSITORY_NAME.git, and the credentials for the Git repository.

5. Click Import.

   The project is added to the Business Central Git repository and is then available in the space.

   Important

   Use the HTTPS or Git protocol instead of a SCP-style SSH URL. Business Central does not support the basic SSH URL and an error appears if you use this URL.

   You must have your public ssh key configured in your Git provider.

   The Git repository must be a KJAR project, containing only a single KJAR that is compatible with the Red Hat Process Automation Manager version. The KJAR content must be in the root of the repository.

6. In a command terminal, navigate to the repository folder:

   cd JBOSS_HOME/bin/.niogit/<SPACE>/REPOSITORY_NAME.git

   Copy to Clipboard Toggle word wrap
7. Create a post-commit file in a hooks folder with permissions set to rwxr—​r--. For example, JBOSS_HOME/bin/.niogit/<SPACE>/REPOSITORY_NAME.git/hooks/post-commit.

8. Add the following content to the post-commit file:

   #!/bin/sh
   git push origin +master

   Copy to Clipboard Toggle word wrap

9. To check that the configuration was successful, create a guided rule in Business Central:

   1. In Business Central go to Menu Projects Add Asset Guided Rule.
   2. On the Create new Guided Rule page, enter the required information.

   3. Click Ok.

      Business Central automatically pushes all changes to the remote repository.

Procedure

1. Create the *.properties file and add a line for each exit code with a corresponding message in the following format:

   <exit_code>=<display_message>

   The <exit_code> is the Git hook exit code and the <display_message> is the custom message that is displayed to a user.

   For example:

   0=Success! All working as expected.
   1=Warning! Please check the logs and advise your admin.
   .
   .
   31=Error! Please advise your admin immediately.

   Copy to Clipboard Toggle word wrap
   Note

   It is 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.

   Important

   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 use their escaped Unicode character code sequences.

2. To enable Git hook notifications, specify the path to the file as the value of the appformer.git.hooks.bundle system property.

   See the following example of a standalone.xml file with the setting that points to a Messages.properties file:

   <system-properties>
     <property name="appformer.git.hooks.bundle" value="/opt/jboss-as/git-hooks-messages/Messages.properties">
     </property>
     ...
   </system-properties>

   Copy to Clipboard Toggle word wrap