如何在Azure DevOps自定义任务中设置Pull Request成功/失败状态？

核心结论 #

azure-pipelines-task-lib/task 库没有直接封装PR状态更新的方法，你需要直接调用Azure DevOps REST API来实现，下面是具体步骤：

实现步骤 #

1. 获取流水线上下文参数 #

在自定义任务中，通过官方任务库提取当前流水线的关键信息：

const task = require('azure-pipelines-task-lib/task');

// 提取PR与项目核心参数
const projectId = task.getVariable('System.TeamProjectId');
const repoId = task.getVariable('Build.Repository.Id');
const pullRequestId = task.getVariable('System.PullRequest.PullRequestId');
const organizationUrl = task.getVariable('System.TeamFoundationCollectionUri');

2. 获取认证令牌 #

Azure DevOps流水线会自动生成访问令牌，直接通过内置变量获取：

const accessToken = task.getVariable('System.AccessToken');

3. 调用REST API更新PR状态 #

可以使用axios或Node.js内置http模块发送请求，以下是axios实现示例（需先在任务的package.json中添加axios依赖）：

const axios = require('axios');

async function updatePRStatus(statusState, description) {
    // 非PR触发的流水线直接跳过
    if (!pullRequestId) {
        task.debug('当前流水线非PR触发，跳过状态更新');
        return;
    }

    const apiEndpoint = `${organizationUrl}${projectId}/_apis/git/repositories/${repoId}/pullrequests/${pullRequestId}/statuses?api-version=7.1`;
    
    const statusPayload = {
        state: statusState, // 可选值：succeeded、failed、pending、notSet
        description: description,
        targetUrl: task.getVariable('Build.BuildUri'), // 关联到当前构建详情页
        context: {
            name: '你的自定义任务标识',
            genre: 'custom-build-task'
        }
    };

    try {
        await axios.post(apiEndpoint, statusPayload, {
            headers: {
                'Authorization': `Bearer ${accessToken}`,
                'Content-Type': 'application/json'
            }
        });
        task.log(`PR状态已更新为${statusState}`);
    } catch (error) {
        task.error(`更新PR状态失败: ${error.message}`);
        task.setResult(task.TaskResult.Failed, 'PR状态更新操作失败');
    }
}

// 根据任务执行结果触发状态更新
const taskResult = task.getResult();
if (taskResult === task.TaskResult.Succeeded) {
    await updatePRStatus('succeeded', '自定义任务执行完成：成功');
} else {
    await updatePRStatus('failed', '自定义任务执行完成：失败');
}

4. 配置权限 #

确保流水线服务账号（Project Collection Build Service）拥有目标Git仓库的Contribute权限：

• 进入仓库设置 → 权限面板 → 找到Project Collection Build Service账号
• 授予Contribute权限，并勾选"允许"生效

注意事项 #

• 仅当流水线由PR触发时，System.PullRequest.PullRequestId变量才会存在，需先做非空判断
• API版本建议使用稳定版（如7.1），避免兼容性问题
• context.name需保持唯一，防止与其他PR状态标识冲突

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