Chapter 38. Git hooks and remote Git repository integration

Procedure

1. Create a post-commit Git hook file:

   $ touch post-commit

   Copy to Clipboard Toggle word wrap

2. Set the permissions of the post-commit file to 755:

   $ chmod 755 post-commit

   Copy to Clipboard Toggle word wrap

3. Add #!/bin/bash and any required code to the post-commit file, for example:

   • To push all changes to a remote repository:

     #!/bin/bash
     git push origin +master

     Copy to Clipboard Toggle word wrap

   • To log a message:

     #!/bin/bash
     echo 'Hello World'

     Copy to Clipboard Toggle word wrap

   • To execute code of another file:

     #!/bin/bash
     java -jar _EAP_HOME_/bin/.niogit/<SPACE>/<PROJECT_NAME>.git/hooks/git-push.jar

     Copy to Clipboard Toggle word wrap
     Note

     To use post-commit Git hooks that execute Java code, you must use the following Java libraries:

     • JGit: Used to interact with internal Business Central Git repositories.
     • GitHub API for Java: Used to communicate with GitHub.

     For more information about post-commit Git hook and Java code examples, see Business Central post-commit Git Hooks Integration.

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 Decision Manager version. The KJAR content must be in the root of the repository.

6. In a command terminal, navigate to the hooks folder located in the repository Git folder of the project. For example:

   $ cd _EAP_HOME_/bin/.niogit/<SPACE>/<PROJECT_NAME>.git/hooks

   Copy to Clipboard Toggle word wrap

7. Create a post-commit file that pushes changes to the remote Git repository. For example:

   #!/bin/sh
   git push origin +master

   Copy to Clipboard Toggle word wrap

   For more information about creating post-commit Git hooks, see Section 38.1, “Creating post-commit Git hooks”.

8. Optional: 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. In a command terminal, navigate to the hooks folder located in the repository Git folder of the project. For example:

   $ cd _EAP_HOME_/bin/.niogit/<SPACE>/<PROJECT_NAME>.git/hooks

   Copy to Clipboard Toggle word wrap

2. Create a post-commit file that pushes changes to the remote Git repository. For example:

   #!/bin/sh
   git push origin +master

   Copy to Clipboard Toggle word wrap

   For more information about creating post-commit Git hooks, see Section 38.1, “Creating post-commit Git hooks”.

3. Optional: 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 a post-commit Git hook in a directory on your local system.

   For more information about creating post-commit Git hooks, see Section 38.1, “Creating post-commit Git hooks”.

2. To specify the directory with the hook file for the value of the org.uberfire.nio.git.hooks system property, do one of the following tasks:

   • Add the org.uberfire.nio.git.hooks system property to the standalone.xml file. For example:

     <system-properties>
       <property name="org.uberfire.nio.git.hooks" value="_EAP_HOME_/hooks">
       </property>
       ...
     </system-properties>

     Copy to Clipboard Toggle word wrap

   • Use the -Dorg.uberfire.nio.git.hooks environment variable when executing Business Central. For example:

     $ ./standalone.sh -c standalone-full.xml -Dorg.uberfire.nio.git.hooks=_EAP_HOME_/hooks

     Copy to Clipboard Toggle word wrap

3. Start Business Central.

   The post-commit Git hook is copied to all Business Central internal repositories and project repositories.

Procedure

1. In a terminal window, clone the GitHub repository to your system:

   $ git clone https://github.com/kiegroup/bc-git-integration-push.git

   Copy to Clipboard Toggle word wrap

2. Navigate to the cloned repository:

   $ cd bc-git-integration-push

   Copy to Clipboard Toggle word wrap

3. Execute a Maven clean install:

   $ mvn clean install

   Copy to Clipboard Toggle word wrap

4. Create a /hooks folder in your EAP_HOME directory:

   $ mkdir -p _EAP_HOME_/hooks/

   Copy to Clipboard Toggle word wrap

5. Copy the git-push-2.1-SNAPSHOT.jar to the EAP_HOME/hooks/ folder:

   $ cp bc-git-integration-push/target/git-push-2.1-SNAPSHOT.jar _EAP_HOME_/hooks/

   Copy to Clipboard Toggle word wrap

6. Optional: To create a template .gitremote configuration file, run git-push-2.1-SNAPSHOT.jar:

   $ java -jar git-push-2.1-SNAPSHOT.jar

   Copy to Clipboard Toggle word wrap

   Example template .gitremote configuration file

   #This is an auto generated template empty property file
   provider=GIT_HUB
   login=
   password=
   token=
   remoteGitUrl=https://api.github.com/
   useSSH=false
   ignore=.*demo.*, test.*
   githubOrg=OrgName
   gitlabGroup=Group/subgroup

   Copy to Clipboard Toggle word wrap

7. Modify the .gitremote configuration file parameters.

   Expand

   Table 38.1. Example .gitremote parameters

   Parameter	Description
   provider	The Git provider. Only two values are accepted: GIT_HUB and GIT_LAB. Required
   login	The user name for the Git provider. Required
   password	A plain text password. Not required if a token is provided.
   token	A generated token to replace the username and password based unsecured connection. Note: If this is not set a warning is displayed that you are using an unsecured connection. Not required if a password is provided. Note: GitLab only supports token authentication.
   remoteGitUrl	A public provider URL or a locally hosted enterprise for any provider. Required. Note: The public GitHub URL should be the API URL. For example, api.github.com.
   useSSH	Boolean to allow the SSH protocol to push changes to the remote repository. Optional. Default = false. Note: This parameter uses the local ~/.ssh/ directory to obtain the SSH configuration.
   ignore	A comma separated regular expressions to ignore project names that match any of these expressions. Optional.
   githubOrg	Defines the repository organization if GitHub is used as the provider. Optional.
   gitlabGroup	Defines the repository group and subgroup if GitLab is used as the provider Optional.

   Show more

8. Create a post-commit Git hook file in EAP_HOME/hooks:

   $ touch post-commit

   Copy to Clipboard Toggle word wrap

9. Set the permissions of the post-commit file to 755:

   $ chmod 755 post-commit

   Copy to Clipboard Toggle word wrap

10. Add #!/bin/bash and code to execute git-push-2.1-SNAPSHOT.jar to the post-commit file:

    $ echo "#\!/bin/bash\njava -jar $APP_SERVER_HOME/hooks/git-push-2.1-SNAPSHOT.jar" > hooks/post-commit

    Copy to Clipboard Toggle word wrap

11. Start Business Central with the -Dorg.uberfire.nio.git.hooks environment variable set. For example:

    $ ./standalone.sh -c standalone-full.xml -Dorg.uberfire.nio.git.hooks=_EAP_HOME_/hooks

    Copy to Clipboard Toggle word wrap

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