This plugin is intended for customers of DX (https://getdx.com/). It shares Jenkins build data with DX.
To run this plugin locally:
- Install Jenkins: https://www.jenkins.io/doc/pipeline/tour/getting-started/
- Setup your developer environment: https://www.jenkins.io/doc/developer/tutorial/prepare/
mvn hpi:run -Dport=5000- Navigate to http://localhost:5000/jenkins
To generate a *.hpi file:
mvn package
-
Run your Jenkins instance. This involves finding
jenkins.war(the location can vary, but if you installed with Homebrew, it is likely/usr/local/Cellar/jenkins/2.451/libexec), and runningJava -jar jenkins.war -
Click "Manage Jenkins"
- Click "Plugins"
- Click "Advanced Settings"
- Click "Choose File" under "Deploy Plugin", and select the *.hpi file
- Once the upload is complete, restart Jenkins
- To confirm the plugin is present, confirm
dx-data-sharer.jpiis present in {jenkins_home}/plugins/ - To confirm the plugin is running, check the console ouput for a build. You should see the message: "Authentication token not found for key: dx_token". Proceed to the next step: Adding your DX API Key to Jenkins.
- Click “Manage Jenkins” in the menu on the left side of the homepage.
- Click “Manage Credentials” in the Security section
- You will see your credentials, if you have any. Click on the store or domain you would like to add your DX API Key to.
- Click “Add Credentials”.
- For "Kind", select “Secret Text”
- Choose your desired scope
- For “Secret”, ass your API Key
- For “ID”, use the string "dx_token"
- For "Description", use “An API Key for the DX API”
- Click “OK”
- Follow the same steps you used to add your API Key, but use the following values: -- ID: "dx_path" -- Secret: your company’s DX URL -- Description: Company-specific DX URL
Report issues and enhancements in the Jenkins issue tracker.
Refer to our contribution guidelines
Licensed under MIT, see LICENSE