Skip to content

Latest commit

 

History

History
78 lines (47 loc) · 2.29 KB

README.md

File metadata and controls

78 lines (47 loc) · 2.29 KB
Raw

Jenkins Yandex Metrica Plugin

Build Status

Yandex Metrica plugin allows to decorate all Jenkins pages with Yandex.Metrica tracking code. It helps you get descriptive reports and record the actions of individual users, find out what they are searching for on the build system, and how do they use it.

Requirements

  • Jenkins LTS 1.580.1 or higher
  • Java SE Runtime Environment 1.8 or higher
  • Yandex Metrica's account and counter

Installation

This plugin is available in the Jenkins Update Center. Official documentation could be found here.

You can install the plugin easily by uploading binary archive to Jenkins through Plugin Manager UI:

  • Build binary release. See "Development section" for additional information.
  • Go to Manage Jenkins -> Manage Plugins.
  • Switch to the "Advanced" tab.
  • In the "Upload Plugin" section, pick the binary downloaded in the first step and press "Upload".

Configuration

Configuration section for this plugin is very simple:

Configuration

You should specify only "Counter ID" parameter to integrate Jenkins with Yandex Metrica.

Development

How to build the hpi file:

  1. Clone the git repository:

    $> git clone https://github.com/vbauer/yandex-metrica-plugin

  2. Change directory to the "yandex-metrica-plugin" repository:

    $> cd yandex-metrica-plugin

  3. Build the hpi file from source:

    $> mvn clean package

  4. The hpi file is located at "target/yandex-metrica.hpi".

  5. If you would like to run a local Jenkins instance with the plug-in:

    $> mvn clean package hpi:run

Contributing guidelines

Feel free to file bugs or pull requests here.

NB: If you would like to send PR, check your build with "strict" profile (it runs PMD and Checkstyle Maven plugins):

$> mvn clean package -P strict

License

Yandex Metrica plugin is licensed under the MIT license. See LICENSE file for more information.