Jenkins
Jenkins is leading open source automation server, Jenkins provides hundreds of plugins to support building, deploying and automating any project.
Categories: Developer Tools
Type: jenkins/v1
Connections
Version: 1
basic_auth
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
username | Username | STRING | Jenkins username. | true |
password | API Token | STRING | Jenkins API token. | true |
baseUri | Base URI | STRING | Complete base URI of your jenkins server. | true |
Actions
Create Job
Name: createJob
Creates a new job.
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
name | Name | STRING | Name of the job. | true |
configXml | Config XML | STRING | Content of the config.xml file. | true |
Example JSON Structure
{
"label" : "Create Job",
"name" : "createJob",
"parameters" : {
"name" : "",
"configXml" : ""
},
"type" : "jenkins/v1/createJob"
}
Output
This action does not produce any output.
Triggers
New Job Status Notification
Name: newJobStatusNotification
Triggers when job statuses are changed.
Type: STATIC_WEBHOOK
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
name | STRING | Name of the Jenkins job. |
display_name | STRING | Display name of the Jenkins job. |
url | STRING | URL of the Jenkins job. |
build | OBJECT Properties{STRING(full_url), INTEGER(number), INTEGER(queue_id), NUMBER(timestamp), INTEGER(duration), STRING(phase), STRING(url), {[](changes), [](culprits)}(scm), STRING(log), STRING(notes), {}(artifacts)} | Jenkins job build. |
JSON Example
{
"label" : "New Job Status Notification",
"name" : "newJobStatusNotification",
"type" : "jenkins/v1/newJobStatusNotification"
}
What to do if your action is not listed here?
If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.
To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.
Additional Instructions
Connection Setup
Create Jenkins API Token
- Click on Manage Jenkins icon.
- Click on Users.
- Click this icon on the user you want to create the API token for.
- Click on Security.
- Click on Add new token.
- Enter name of the token and then click on Generate.
- Copy token, you will not be able to see the whole token again.
- Click on Done.
Trigger Setup
Enable Notification Plugin
- Click this icon.
- Click on Plugins.
- Click on Available plugins.
- Search for notification.
- Click on Notification from Tikal Knowledge. Notification plugin link
- Click here.
- Click on Install.
- Wait for everything to finish downloading.
- Click on Go back to the top page.
Trigger URL Setup
- Select Jenkins job to which you want to connect the trigger to.
- Click this Configure.
- Click on Add Endpoint.
- Paste Webhook URL. See Deploy documentation on how to get Webhook URL.
- Click on Save.