> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flexagon.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Jenkins

> FlexDeploy offers integration with Jenkins via a pair of plugins; one for FlexDeploy, and one for Jenkins. For a quick guide on configuring these plug

FlexDeploy offers integration with Jenkins via a pair of plugins; one for FlexDeploy, and one for Jenkins.

> [!NOTE]
>
> For a quick guide on configuring these plugins and using them together, check out the [Getting Started with the Jenkins Plugin](https://docs.flexagon.com/flexdeploy-11-2-documentation/flexdeploy-external-tool-integration/jenkins/getting-started-with-the-jenkins-plugin.md) page.
>
> You can invoke Jenkins from FlexDeploy using shell plugin(s), see [Invoking Jenkins job from command line](https://docs.flexagon.com/flexdeploy-11-2-documentation/flexdeploy-external-tool-integration/jenkins/invoking-jenkins-job-from-command-line.md) for quick reference.
>
> If you are looking to migrate Jenkins jobs to FlexDeploy, see [Migrate Jenkins job to FlexDeploy](https://docs.flexagon.com/flexdeploy-11-2-documentation/flexdeploy-external-tool-integration/jenkins/migrate-jenkins-job-to-flexdeploy.md).

# The FlexDeploy Plugin

The FlexDeploy Jenkins Plugin offers the ability to get a completed Jenkins build and put it into the FlexDeploy artifact repository. Once the artifact is brought into FlexDeploy, we can use it in any project build or deployment.

The plugin is further documented in the [FlexDeploy Jenkins Plugin Guide](https://docs.flexagon.com/flexdeploy-11-2-documentation/flexdeploy-plugin-guides/flexdeploy-jenkins-plugin-guide.md).

# The Jenkins Plugin

The Jenkins plugin can be downloaded in the Jenkins UI or manually [here](https://github.com/jenkinsci/flexdeploy-plugin).

This plugin for Jenkins runs as a post-build step that can build a project in FlexDeploy. This provides the ability to start a build in FlexDeploy after completing a job or project in Jenkins.

## Plugin Inputs

<table><colgroup><col /><col /><col /><col /></colgroup><tbody><tr><th>**Input Name**</th><th>**Required**</th><th>**Description**</th><th>**Example**</th></tr><tr><td>FlexDeploy URL</td><td>Yes</td><td>The URL of FlexDeploy running on a server.</td><td>`http://FlexFeployServer:8000/flexdeploy`</td></tr><tr><td>Qualified Project Path</td><td>Yes</td><td>The fully qualified path to a project in FlexDeploy.</td><td>`FlexDeploy/Folder/Path/To/Project`</td></tr><tr><td>Environment Code</td><td>Yes</td><td>The code for the environment to build this project in.</td><td>`DEV01`</td></tr><tr><td>Branch Name</td><td>Yes</td><td>The branch name to use in FlexDeploy. Defaults to 'trunk'. Only needs to be changed if project defaults to different branch name.</td><td>`trunk`</td></tr><tr><td>Force Build</td><td>No</td><td>Check this box if you want to force the build to execute if no changes are detected.</td><td>`N/A`</td></tr><tr><td>Credentials</td><td>Yes</td><td>Choose to either use the Credentials plugin, or use a Username and Password.</td><td>`N/A`</td></tr><tr><td>Test Connection Button</td><td>No</td><td>Validate your connection to FlexDeploy. This will validate both the FlexDeploy URL, and the credentials you chose.</td><td>`N/A`</td></tr></tbody></table>

## Advanced

<table><colgroup><col /><col /><col /></colgroup><tbody><tr><th>**Input Name**</th><th>**Required**</th><th>**Description**</th></tr><tr><td>Release Definition Name</td><td>No</td><td>The name of the release to associate this project build to.</td></tr><tr><td>Package Name</td><td>No</td><td>Package Name is required if building a package-based project. It is not allowed otherwise. For a dynamic package, using `.*` considers that package as All Files requested.</td></tr><tr><td>Workflow Version Override</td><td>No</td><td>Optional Workflow Version name to override current version. (e.g. `1.2`)</td></tr><tr><td>Issue Numbers</td><td>No</td><td>Comma-separated list of issue numbers. (e.g. `GLORY-50,PROJECT-4234,GITHUBREPO-23545`)</td></tr><tr><td>Wait for FlexDeploy</td><td>No</td><td>Check this box to wait for the FlexDeploy workflow to complete. If the workflow fails, the Jenkins project will also fail.</td></tr><tr><td>Inputs</td><td>No</td><td>This section is used for custom inputs. If you have any workflow inputs on your build workflow, this is where they should be defined. Environment variables can be used for the `Value` field here. For example, passing in the value `BUILD_ID` will return the id of the current build.</td></tr><tr><td>Flex Fields</td><td>No</td><td>Define any build FlexFields you have configured. The `Value` field can handle environment variables such as `BUILD_ID`.</td></tr><tr><td>Build File Inputs</td><td>No</td><td>List of build file inputs requiring either SCM Revision or From Package Object Id, or both.</td></tr></tbody></table>