n8n-nodes-jenkins

This is an n8n community node. It lets you use Jenkins in your n8n workflows.

Jenkins is a popular open-source automation server that helps automate the non-human part of the software development process, with continuous integration and facilitating technical aspects of continuous delivery. This node provides comprehensive integration with Jenkins REST API, allowing you to manage jobs, builds, and artifacts directly from your n8n workflows.

n8n is a fair-code licensed workflow automation platform.

Installation
Operations
Credentials
Compatibility
Usage
Resources
Version history

Installation

Follow the installation guide in the n8n community nodes documentation.

Operations

This Jenkins node supports two main resource types with various operations:

Job Management

• List All Jobs - Retrieve a list of all jobs from your Jenkins instance
• Get Job Details - Get detailed information about a specific job
• Create Job - Create a new job using XML configuration
• Update Job Config - Update an existing job's configuration
• Get Job Config - Retrieve the XML configuration of a specific job
• Trigger Job Build - Start a parameterless build of a specific job
• Trigger Job Build with Parameters - Start a build with custom parameters
• Delete Job - Remove a specific job from Jenkins

Build Management

• Get Build - Retrieve details of a specific build
• Get Last Build - Get information about the most recent build
• Get Last Successful Build - Retrieve details of the last successful build
• Get Last Failed Build - Get information about the last failed build
• Stop Build - Stop a running build
• Get Build Console Output - Retrieve the console output/logs of a build
• List Build Artifacts - Get a list of artifacts generated by a build
• Get Build Artifact - Download a specific artifact from a build

Credentials

To use this node, you need to set up Jenkins API credentials. You'll need:

1. Jenkins Base URL - The URL of your Jenkins instance (e.g., https://jenkins.example.com)
2. Username - Your Jenkins username
3. API Key - Your Jenkins API token or password

Setting up Jenkins API Access

1. Generate an API Token (Recommended):

   • Log into your Jenkins instance
   • Go to your user profile (top right corner)
   • Click on "Security"
   • In the "API Token" section, give your token a name and click "Add new Token"
   • Copy the generated token

2. Alternative: Use Password:

   • You can use your Jenkins password instead of an API token
   • Note: API tokens are more secure and recommended

3. Configure the Credential in n8n:

   • In n8n, go to Settings → Credentials
   • Click "Add Credential"
   • Select "Jenkins Credentials API"
   • Enter your Jenkins Base URL, Username, and API Key/Password
   • Test the connection to ensure it works

Compatibility

• Node.js version: >=20.15
• Tested with: n8n 1.100.1

Usage

Basic Job Operations

List All Jobs:

• Use this operation to get an overview of all jobs in your Jenkins instance
• You can specify custom job fields to retrieve specific information

Trigger a Build:

• Use "Trigger Job Build" for parameterless builds
• Use "Trigger Job Build with Parameters" when your job requires parameters
• Parameters are specified as name-value pairs

Build Management

Monitor Build Status:

• Use "Get Last Build" to check the status of the most recent build
• Use "Get Build Console Output" to retrieve build logs for debugging
• Use "Stop Build" to cancel a running build if needed

Artifact Management:

• Use "List Build Artifacts" to see what artifacts were generated
• Use "Get Build Artifact" to download specific artifacts for further processing

Advanced Usage

Job Configuration Management:

• Use "Get Job Config" to retrieve the XML configuration of a job
• Use "Update Job Config" to modify job settings programmatically
• Use "Create Job" to set up new jobs from XML templates

Workflow Integration Examples:

• Trigger builds when code is pushed to a repository
• Monitor build status and send notifications on failure
• Download and process build artifacts automatically
• Create jobs dynamically based on project requirements

Resources

• n8n community nodes documentation
• Jenkins REST API documentation
• Jenkins API Token setup guide
• Jenkins CLI documentation

Version history

0.1.0

• Initial release
• Support for Job Management operations (list, create, update, delete, trigger builds)
• Support for Build Management operations (get build details, console output, artifacts)
• Basic authentication with username/password or API token
• Binary data support for job configurations and artifacts