JIRA插件中如何在后置构建操作中访问环境变量

87次阅读

问题描述

在Jenkins中安装了JIRA插件，并在“后置构建操作”菜单中添加了一项动作：JIRA: 更新相关问题。然而，在尝试访问环境变量时，遇到了错误。
具体错误信息如下：

WARNING: jira rest client get issue from jql search error. cause: RestClientException{statusCode=Optional.of(400), errorCollections=[ErrorCollection{status=400, errors={}, errorMessages=[The issue key '$MY_ISSUE_ID' for field 'issue' is invalid.]}]}java.util.concurrent.ExecutionException: RestClientException{statusCode=Optional.of(400), errorCollections=[ErrorCollection{status=400, errors={}, errorMessages=[The issue key '$MY_ISSUE_ID' for field 'issue' is invalid.]}]}    at com.google.common.util.concurrent.AbstractFuture$Sync.getValue(AbstractFuture.java:289)    ...

用户已经确认$MY_ISSUE_ID是有效的环境变量，并且在构建的其他部分可以正常访问它。用户尝试了一些方式，如issue=${XXXX}、issue=XXXX、issue="$XXXX"等，但都无法解决问题。用户还尝试了参考答案中提供的env. MY_ISSUE_ID，但仍然遇到了相同的错误。

用户希望知道如何在JIRA插件的后置构建操作中正确地传递环境变量，以便能够使用类似issue=${MY_ISSUE_ID}的方式。

解决方案

JIRA插件的后置构建操作部分需要正确使用环境变量。以下是在Jenkins中正确使用环境变量的两种常见方法，这些方法在大多数情况下可以正常工作。

请注意以下操作注意版本差异及修改前做好备份。

方案1：在Pipeline中使用环境变量

在Jenkins的Pipeline中，可以使用env关键字来设置和访问环境变量。以下是一个示例Pipeline，其中设置了MY_ISSUE_ID环境变量并在构建步骤中访问它：

pipeline {
  agent any
  environment {
    MY_ISSUE_ID = 'PROJECT-1234'
  }
  stages {
    stage('Build') {
      steps {
        echo env.MY_ISSUE_ID
        // 在这里执行后续的构建操作，包括JIRA插件的操作
      }
    }
  }
}

在上述示例中，我们首先使用environment块定义了MY_ISSUE_ID环境变量，然后在Build阶段的步骤中使用echo env.MY_ISSUE_ID来访问它。你可以在Build阶段的后续步骤中继续执行其他构建操作，包括使用JIRA插件的操作。

方案2：使用Shell步骤设置环境变量

在Jenkins中，你还可以使用Shell步骤来设置环境变量，然后在后续的构建步骤中访问它。以下是一个示例Pipeline，其中使用Shell步骤设置了MY_ISSUE_ID环境变量并在后续的构建步骤中访问它：

pipeline {
  agent any
  stages {
    stage('Set Environment Variable') {
      steps {
        sh '''
          MY_ISSUE_ID="PROJECT-1234"
          echo "MY_ISSUE_ID=$MY_ISSUE_ID" > MY_issue.property
        '''
      }
    }
    stage('Build') {
      steps {
        echo 'Performing build steps...'
        // 在这里执行后续的构建操作，包括使用JIRA插件的操作
      }
    }
  }
}

在上述示例中，我们在Set Environment Variable阶段的Shell步骤中设置了MY_ISSUE_ID环境变量，并将其保存到MY_issue.property文件中。然后，在后续的Build阶段中，你可以继续执行其他构建操作，包括使用JIRA插件的操作。在这个示例中，你需要根据实际情况修改构建步骤，以适应你的需求。

选择适合你的方法，根据Jenkins的Pipeline语法或Shell脚本语法，正确设置和访问环境变量。通过确保正确设置环境变量，你应该能够在JIRA插件的后置构建操作中使用issue=${MY_ISSUE_ID}等方式来传递环境变量。

请记住，以上示例中的环境变量名称MY_ISSUE_ID和值PROJECT-1234仅作为示例。你应该根据你的实际需求设置和访问适当的环境变量。

正文完