mirror of
https://github.com/appleboy/drone-jenkins.git
synced 2026-06-04 18:23:57 +08:00
docs: add drone documents. (#11)
This commit is contained in:
@@ -0,0 +1,96 @@
|
||||
---
|
||||
date: 2017-01-16T00:00:00+00:00
|
||||
title: Jenkins
|
||||
author: appleboy
|
||||
tags: [ infrastructure, trigger, jenkins ]
|
||||
repo: appleboy/drone-jenkins
|
||||
logo: jenkins.svg
|
||||
image: appleboy/drone-jenkins
|
||||
---
|
||||
|
||||
The Jenkins plugin allows you to trigger Jenkins job automatically. The below pipeline configuration demonstrates simple usage:
|
||||
|
||||
```yaml
|
||||
pipeline:
|
||||
jenkins:
|
||||
image: appleboy/drone-jenkins
|
||||
url: http://example.com
|
||||
user: appleboy
|
||||
token: xxxxxxxxxx
|
||||
job: drone-jenkins-plugin-job
|
||||
```
|
||||
|
||||
Example configuration for success builds:
|
||||
|
||||
```diff
|
||||
pipeline:
|
||||
jenkins:
|
||||
image: appleboy/drone-jenkins
|
||||
url: http://example.com
|
||||
user: appleboy
|
||||
token: xxxxxxxxxx
|
||||
job: drone-jenkins-plugin-job
|
||||
+ when:
|
||||
+ status: [ success ]
|
||||
```
|
||||
|
||||
Example configuration with multiple jobs:
|
||||
|
||||
```yaml
|
||||
pipeline:
|
||||
jenkins:
|
||||
image: appleboy/drone-jenkins
|
||||
url: http://example.com
|
||||
user: appleboy
|
||||
token: xxxxxxxxxx
|
||||
job:
|
||||
+ - drone-jenkins-plugin-job-1
|
||||
+ - drone-jenkins-plugin-job-2
|
||||
```
|
||||
|
||||
Example configuration with jobs in the folder:
|
||||
|
||||
```yaml
|
||||
pipeline:
|
||||
jenkins:
|
||||
image: appleboy/drone-jenkins
|
||||
url: http://example.com
|
||||
user: appleboy
|
||||
token: xxxxxxxxxx
|
||||
+ job: folder_name/job_name
|
||||
```
|
||||
|
||||
It will trigger the URL of Jenkins job like as `http://example.com/job/folder_name/job/job_name/`
|
||||
|
||||
# Secrets
|
||||
|
||||
The Jenkins plugin supports reading credentials from the Drone secret store. This is strongly recommended instead of storing credentials in the pipeline configuration in plain text.
|
||||
|
||||
```diff
|
||||
pipeline:
|
||||
jenkins:
|
||||
image: appleboy/drone-jenkins
|
||||
url: http://example.com
|
||||
user: appleboy
|
||||
- token: xxxxxxxxxx
|
||||
job: drone-jenkins-plugin-job
|
||||
```
|
||||
|
||||
The `token` attribute can be replaced with the below secret environment variables. Please see the Drone documentation to learn more about secrets.
|
||||
|
||||
PLUGIN_TOKEN
|
||||
: user token
|
||||
|
||||
# Parameter Reference
|
||||
|
||||
url
|
||||
: jenkins server base url.
|
||||
|
||||
user
|
||||
: jenkins user account
|
||||
|
||||
token
|
||||
: jenkins user token
|
||||
|
||||
job
|
||||
: jenkins job name
|
||||
@@ -1,3 +1,5 @@
|
||||
<img src="logo.png">
|
||||
|
||||
# drone-jenkins
|
||||
|
||||
[](https://godoc.org/github.com/appleboy/drone-jenkins) [](http://drone.wu-boy.com/appleboy/drone-jenkins) [](https://codecov.io/gh/appleboy/drone-jenkins) [](https://goreportcard.com/report/github.com/appleboy/drone-jenkins) [](https://hub.docker.com/r/appleboy/drone-jenkins/) [](https://microbadger.com/images/appleboy/drone-jenkins "Get your own image badge on microbadger.com")
|
||||
|
||||
Reference in New Issue
Block a user