Jenkins参数化项目：如何通过Pipeline用VAR1配置Xray插件参数

Hey there! I’ve been in your shoes before—figuring out how to tie Jenkins parameters to plugin steps can feel tricky when you’re starting out. Let’s break down exactly how to link your VAR1 parameter to the Xray Cucumber Features Export step in a Pipeline.

Step 1: Define Your Parameter in the Pipeline #

First, make sure your Pipeline recognizes the VAR1 parameter. Add a parameters block at the top of your Pipeline to declare it—this tells Jenkins to prompt for a value when triggering a build.

Step 2: Reference the Parameter in the Xray Step #

When configuring the xrayCucumberExport step (the Pipeline equivalent of the "Xray: Cucumber Features Export" build step), you can directly reference VAR1 using Groovy variable syntax. Here’s a complete working example:

pipeline {
    agent any
    parameters {
        // Declare your VAR1 parameter—adjust the description to fit your use case
        string(name: 'VAR1', description: 'Enter JIRA issue key(s) (comma-separated for multiple)')
    }
    stages {
        stage('Export Features from Xray') {
            steps {
                // Call the Xray Cucumber Export step and pass VAR1 to the issues field
                xrayCucumberExport(
                    jiraInstance: 'Your JIRA Instance Name', // Replace with your configured JIRA instance name
                    issues: "${VAR1}", // This is where we link VAR1 to the Issues parameter
                    filePath: 'exported_features' // Set your desired output path for features
                    // Uncomment below if you need to use a filter (optional)
                    // filter: 'YOUR_FILTER_ID',
                )
            }
        }
    }
}

Key Notes to Make This Work: #

• JIRA Instance Name: Double-check that the value for jiraInstance matches exactly what’s configured in your Jenkins global settings (under "Xray for JIRA" configuration).
• Variable Syntax: Using ${VAR1} inside double quotes ensures Groovy parses the parameter value correctly. If you use single quotes, it’ll treat VAR1 as literal text—so stick with double quotes here.
• Multiple Issues: If VAR1 needs to include multiple issue keys, just separate them with commas (e.g., TEST-123,TEST-456)—the Xray plugin will handle this automatically.

How to Verify It’s Working: #

Trigger a build, enter a valid JIRA issue key in the VAR1 prompt, then check the build logs. You should see the Xray step using the exact issue key(s) you entered, and the exported features will be saved to the filePath you specified.

内容的提问来源于stack exchange，提问作者SamuelTJackson