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 plugins and using them together, check out the Getting Started with the Jenkins Plugin page.

You can invoke Jenkins from FlexDeploy using shell plugin(s), see Invoking Jenkins job from command line for quick reference.

If you are looking to migrate Jenkins jobs to FlexDeploy, see Migrate Jenkins job to FlexDeploy.

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.

The Jenkins Plugin

The Jenkins plugin can be downloaded in the Jenkins UI or manually here.

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

Input Name

Required

Description

Example

Input Name

Required

Description

Example

FlexDeploy URL

Yes

The URL of FlexDeploy running on a server.

http://FlexFeployServer:8000/flexdeploy

Qualified Project Path

Yes

The fully qualified path to a project in FlexDeploy.

FlexDeploy/Folder/Path/To/Project

Environment Code

Yes

The code for the environment to build this project in.

DEV01

Branch Name

Yes

The branch name to use in FlexDeploy. Defaults to 'trunk'. Only needs to be changed if project defaults to different branch name.

trunk

Force Build

No

Check this box if you want to force the build to execute if no changes are detected.

N/A

Credentials

Yes

Choose to either use the Credentials plugin, or use a Username and Password.

N/A

Test Connection Button

No

Validate your connection to FlexDeploy. This will validate both the FlexDeploy URL, and the credentials you chose.

N/A

Advanced

Input Name

Required

Description

Input Name

Required

Description

Release Definition Name

No

The name of the release to associate this project build to.

Package Name

No

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.

Workflow Version Override

No

Optional Workflow Version name to override current version. (e.g. 1.2)

Issue Numbers

No

Comma-separated list of issue numbers. (e.g. GLORY-50,PROJECT-4234,GITHUBREPO-23545)

Wait for FlexDeploy

No

Check this box to wait for the FlexDeploy workflow to complete. If the workflow fails, the Jenkins project will also fail.

Inputs

No

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.

Flex Fields

No

Define any build FlexFields you have configured. The Value field can handle environment variables such as BUILD_ID.

Build File Inputs

No

List of build file inputs requiring either SCM Revision or From Package Object Id, or both.



The following macros are not currently supported in the footer:
  • style