gerrit-to-platform¶
Gerrit hooks to allow using GitHub and GitLab as CI platforms.
To use, install the Gerrit hooks plugin and then symlink the hooks from the virtualenv that has the package installed.
A Python 3.8 or greater environment
Repositories that use the CI platform must have full mirroring replication
configured. In specific refs/* must be in the replication set and not
refs/heads/*
To activate a given hook, symlink the installed hook in the gerrit hooks directory.
Two configuration files needed. These files are:
~gerrituser/.config/gerrit_to_platform/gerrit_to_platform.ini~gerrituser/.config/gerrit_to_platform/replication.config
The replication.config file should be a symlink to the standard Gerrit replication.config file
The gerrit_to_platform.ini file has the following format:
[mapping "content-added"]
recheck = verify
remerge = merge
[github.com]
token = <a_token_that_allows_triggering_actions>
[gitlab.com]
token = <a_token_that_allows_triggering_workflows>
The content-added mapping section is a key value pair for comment triggers
to the corresponding workflow name or filename
Making Changes & Contributing¶
This project uses pre-commit, please make sure to install it before making any changes:
pip install pre-commit
cd gerrit_to_platform
pre-commit install
pre-commit install -t commit-msg
Don’t forget to tell your contributors to also install and use pre-commit.
Note¶
PyScaffold 4.4 provided the initial project setup. For details and usage information on PyScaffold see https://pyscaffold.org/.