A hook for our company's legacy Gerrit to integrate Change-Id's into Jira >=v7.0
Build the standalone executable using pyinstaller:
pip install pyinstaller
pyinstaller --onefile gerrit-jira-hook.py
This will give the executable directly containing the entire Python runtime and all dependencies in dist/gerrit-jira-hook.
Navigate to the Gerrit instance's Gerrit directory (usually in /var/gerrit/). This directory will be referred to as $GERRIT_HOME. $GERRIT_SITE is the site's directory.
Simply copy the gerrit-jira-hook executable to $GERRIT_SITE/hooks and the corresponding gerrit-jira-hook.config-file to $GERRIT_HOME. Verify that the executable actually has the correct permissions and ownership to be able to run. That's it. Simple as that.
Configure the hook by setting the appropriate values in $GERRIT_HOME/gerrit-jira-hook.config for the Jira connection:
[gerrit-jira-hook]
jira_url = https://jira.example.com # The remote Jira server instance
jira_user = username # A Jira user with permission to add comments to tickets
jira_pass = access_token/password # A Jira API access token
jira_use_field = true # If set to true change information will be updated in the field specified below
jira_field = jira_field_name # The field to update
jira_update_components = true # Automatically update component list in Jira, if true [gerrit-project-to-jira-component-mappings]-section must be configured, otherwise can be left empty
gerrit_user = gerrit_jira # A user with full SSH access to Gerrit
gerrit_host = localhost # The Gerrit sshd host
gerrit_projects = All-Projects # Run hook for all projects
# OR:
gerrit_projects = project1,project2,project3 # Run hook only for certain projects
[gerrit-project-to-jira-component-mappings] # List all your Gerrit projects and their corresponding Jira component mappings here
gerrit_project1 = jira_component1
gerrit_project2 = jira_component2
The gerrit_user must be a user with full SSH access to Gerrit. It must be configured to have access via authorized public key.
Add the following configuration to $GERRIT_HOME/etc/gerrit.config:
[hooks]
path = $GERRIT_HOME/hooks
changeMergedHook = gerrit-jira-hook
You should now see your Jira ticket being updated whenever the corresponding valid Jira Issue-Id is found in the commit message. Enjoy!
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent