Jenkins Job上传参数文件至GitHub失败求助

需求 #

创建Jenkins任务，接收用户上传的文件参数，将该文件推送至指定GitHub仓库。

当前使用的Pipeline代码 #

pipeline {
    agent {
         label 'linux'
        }
    parameters {
         file(
             name:'file.yml', 
             description:'YAML file'
            )
    }
        
    stages {
        stage('github clone'){
            steps {
         git url: 'https://token@github.com/user/repo.git', branch: 'branch_name'
            }
        }
        stage('push'){
            steps {
                    sh 'git add folder/folder/${file.yml}'
                    sh 'git commit -m \"upload new file\" '
                    sh 'git push origin branch_name
            }
        }
  
    }
}

执行报错日志 #

Started by user me
[Pipeline] Start of Pipeline
[Pipeline] node
Running on serverName in /home/jenkins/workspace/
[Pipeline] {
[Pipeline] stage
[Pipeline] { (github clone)
[Pipeline] git
The recommended git tool is: NONE
No credentials specified
Fetching changes from the remote Git repository
Checking out Revision 123456 (refs/remotes/origin/branch_name)
Commit message: ""
 > git rev-parse --resolve-git-dir /home/jenkins/workspace/branch_name/.git # timeout=10
 > git config remote.origin.url https://token@github.com/user/repo.git # timeout=10
Fetching upstream changes from https://token@github.com/user/repo.git
 > git --version # timeout=10
 > git --version # 'git version 2.25.1'
 > git fetch --tags --force --progress -- https://token@github.com/user/repo.git +refs/heads/*:refs/remotes/origin/* # timeout=10
 > git rev-parse refs/remotes/origin/branch_name^{commit} # timeout=10
 > git config core.sparsecheckout # timeout=10
 > git checkout -f 123456 # timeout=10
 > git branch -a -v --no-abbrev # timeout=10
 > git branch -D branch_name # timeout=10
 > git checkout -b branch_name 123456 # timeout=10
 > git rev-list --no-walk 123456 1 # timeout=10
[Pipeline] }
[Pipeline] // stage
[Pipeline] stage
[Pipeline] { (push)
[Pipeline] sh

问题分析与修复方案 #

从日志能看到，任务走到push阶段的sh步骤就失败了，结合代码细节，问题集中在以下几点：

1. 文件参数路径处理错误 #

Jenkins的file参数上传后，文件存放在工作空间的临时路径中，直接使用${file.yml}无法定位到文件，需要先将上传文件复制到仓库的目标目录，再执行Git操作。

2. Git命令语法错误 #

• git add使用单引号包裹时，${file.yml}不会被解析为实际路径，需改用双引号；且直接引用参数名的路径写法错误，需先完成文件复制。
• git commit中的转义引号多余，单引号内无需转义双引号。
• git push命令缺少闭合引号，存在语法错误。

3. Git权限与配置缺失 #

直接在URL中明文写token不安全，且日志提示No credentials specified，建议通过Jenkins凭证管理存储GitHub令牌，用credentials()方法调用；同时提交Git时需配置用户名和邮箱，否则会触发提交失败。

修复后的完整Pipeline代码 #

pipeline {
    agent {
        label 'linux'
    }
    parameters {
        file(
            name: 'file.yml', 
            description: 'YAML file'
        )
    }
    environment {
        // 替换为你在Jenkins中配置的GitHub令牌凭证ID
        GITHUB_TOKEN = credentials('github-token')
        REPO_URL = "https://${GITHUB_TOKEN}@github.com/user/repo.git"
        // 文件要存放的仓库目录
        TARGET_DIR = 'folder/folder'
    }
    stages {
        stage('准备文件') {
            steps {
                // 确保目标目录存在
                sh "mkdir -p ${TARGET_DIR}"
                // 将上传的文件复制到仓库目录下
                sh "cp ${file.yml} ${TARGET_DIR}/"
            }
        }
        stage('克隆仓库') {
            steps {
                git url: "${REPO_URL}", branch: 'branch_name'
            }
        }
        stage('推送文件') {
            steps {
                script {
                    // 配置Git提交用户信息，首次提交必须配置
                    sh 'git config --global user.name "Jenkins Bot"'
                    sh 'git config --global user.email "jenkins@yourdomain.com"'
                    
                    // 获取上传文件的纯文件名，避免路径问题
                    def fileName = sh(script: "basename ${file.yml}", returnStdout: true).trim()
                    
                    // 执行Git操作
                    sh "git add ${TARGET_DIR}/${fileName}"
                    sh 'git commit -m "Upload new YAML file"'
                    sh "git push ${REPO_URL} branch_name"
                }
            }
        }
    }
}

额外注意事项 #

• 确保Jenkins节点的Git版本兼容，当前使用的2.25.1版本满足需求。
• 检查Jenkins服务器是否具备访问GitHub的网络权限，避免克隆或推送超时。
• 确认目标仓库的branch_name分支已存在，若需创建新分支，需添加对应的Git分支创建命令。

内容的提问来源于stack exchange，提问作者milk_away.89