GitLab Plugin system
Introduced in GitLab 10.6.
With custom plugins, GitLab administrators can introduce custom integrations without modifying GitLab's source code.
NOTE: Note: Instead of writing and supporting your own plugin you can make changes directly to the GitLab source code and contribute back upstream. This way we can ensure functionality is preserved across versions and covered by tests.
NOTE: Note: Plugins must be configured on the filesystem of the GitLab server. Only GitLab server administrators will be able to complete these tasks. Explore system hooks or webhooks as an option if you do not have filesystem access.
A plugin will run on each event so it's up to you to filter events or projects within a plugin code. You can have as many plugins as you want. Each plugin will be triggered by GitLab asynchronously in case of an event. For a list of events see the system hooks documentation.
The plugins must be placed directly into the
plugins directory, subdirectories
will be ignored. There is an
example directory inside
where you can find some basic examples.
Follow the steps below to set up a custom hook:
On the GitLab server, navigate to the plugin directory. For an installation from source the path is usually
/home/git/gitlab/plugins/. For Omnibus installs the path is usually
For highly available configurations, your hook file should exist on each application server.
pluginsdirectory, create a file with a name of your choice, without spaces or special characters.
Make the hook file executable and make sure it's owned by the Git user.
Write the code to make the plugin function as expected. That can be in any language, and ensure the 'shebang' at the top properly reflects the language type. For example, if the script is in Ruby the shebang will probably be
The data to the plugin will be provided as JSON on STDIN. It will be exactly same as for system hooks
That's it! Assuming the plugin code is properly implemented, the hook will fire as appropriate. The plugins file list is updated for each event, there is no need to restart GitLab to apply a new plugin.
If a plugin executes with non-zero exit code or GitLab fails to execute it, a message will be logged to:
gitlab-rails/plugin.login an Omnibus installation.
log/plugin.login a source installation.
Below is an example that will only response on the event
will inform the admins from the GitLab instance that a new project has been created.
# By using the embedded ruby version we eliminate the possibility that our chosen language # would be unavailable from #!/opt/gitlab/embedded/bin/ruby require 'json' require 'mail' # The incoming variables are in JSON format so we need to parse it first. ARGS = JSON.parse(STDIN.read) # We only want to trigger this plugin on the event project_create return unless ARGS['event_name'] == 'project_create' # We will inform our admins of our gitlab instance that a new project is created Mail.deliver do from 'info@gitlab_instance.com' to 'admin@gitlab_instance.com' subject "new project " + ARGS['name'] body ARGS['owner_name'] + 'created project ' + ARGS['name'] end
Writing your own plugin can be tricky and it's easier if you can check it without altering the system. A rake task is provided so that you can use it in a staging environment to test your plugin before using it in production. The rake task will use a sample data and execute each of plugin. The output should be enough to determine if the system sees your plugin and if it was executed without errors.
# Omnibus installations sudo gitlab-rake plugins:validate # Installations from source cd /home/git/gitlab bundle exec rake plugins:validate RAILS_ENV=production
Example of output:
Validating plugins from /plugins directory * /home/git/gitlab/plugins/save_to_file.clj succeed (zero exit code) * /home/git/gitlab/plugins/save_to_file.rb failure (non-zero exit code)