从 Azure DevOps 获取已通过 JavaScript 合并到分支中的所有工作项

Question

这个想法

我目前正在使用 NodeJS 开发一个“发行说明”应用程序，该应用程序调用各种 Azure DevOps REST API 端点来获取基于特定标签的工作项。

我现在拥有的

我现在所拥有的工作原理如下；

• Azure DevOps 上的一些工作项（自定义）标记有v1.1.
• 我编写的 JS 函数会获取与给定v1.1标签匹配的所有工作项。
• 维基条目是使用生成的降价创建的，显示每个工作项的细分（格式对问题并不重要）。

/**
 * Function used to fetch initial work items from Azure DevOps that match the provided release number
 * @param {String} releaseNumber - the given release number
 * @returns {Array} workItems - the initial work items fetched from Azure DevOps
 */
async function fetchWorkItems(releaseNumber) {
    console.log('\nFetching work items for given release number...');
    let response;
    try {
        response = await axios.post('https://dev.azure.com/myTestOrg/myTestProject/_apis/wit/wiql?api-version=6', {
            query: `SELECT [State], [Title] FROM WorkItems WHERE [Tags] CONTAINS '${releaseNumber}'`
        }, {
            headers: {
                Authorization: getAuthToken()
            }
        });
        console.log(`Found ${response.data.workItems.length} work item(s).`);
    } catch (e) {
        console.error('\nUnable to fetch work items. See below error message');
        console.error(e.message);
        process.exit(1);
    }

    return response.data.workItems;
}

/**
 * Function used to fetch the details for a given array of work items
 * @param {Array} givenWorkItems - given array of work items to fetch the details for
 * @returns {Array} details - the initial work items fetched from Azure DevOps
 */
async function fetchWorkItemDetails(givenWorkItems) {
    console.log('\nFetching further details for the given work item(s)...');
    const returnData = [];
    let response;

    for (const item of givenWorkItems) {
        try {
            // eslint-disable-next-line no-await-in-loop
            response = await axios.get(item.url, {
                headers: {
                    Authorization: getAuthToken()
                }
            });
        } catch (e) {
            console.error('\nUnable to fetch details for given work items. See below error message');
            console.error(e.message);
            process.exit(1);
        } finally {
            returnData.push({
                type: response.data.fields['System.WorkItemType'],
                title: response.data.fields['System.Title'],
                url: response.data._links.html.href
            });
        }
    }

    console.log(`Found details for ${returnData.length} work item(s).`);
    return returnData;
}

...

/**
 * Function used to create the wiki entry based on a given markup string
 * @param {String} releaseNumber - the given release number
 * @param {String} givenMarkdown - given array of work items to fetch the details for
 * @returns {undefined} nothing
 */
async function createWiki(releaseNumber, givenMarkdown) {
    console.log('\nCreating wiki entry...');
    try {
        await axios.put(`https://dev.azure.com/myTestOrg/myTestProject/_apis/wiki/wikis/myTestProject.wiki/pages?path=/Releases/Release%20${releaseNumber}&api-version=6.0`, {
            content: givenMarkdown
        }, {
            headers: {
                Authorization: getAuthToken()
            }
        });
    } catch (e) {
        console.error('\nUnable to create wiki entry for given markdown. See below error message');
        console.error(e.message);
        process.exit(1);
    } finally {
        console.log('Successfully created wiki entry.');
    }
}

...

const workItems = await fetchWorkItems(releaseNumber);
const workItemDetails = await fetchWorkItemDetails(workItems);
const formattedDetails = formatWorkItemDetails(workItemDetails);
const generatedMarkup = generateMarkdown(formattedDetails);
await createWiki(releaseNumber, generatedMarkup);
...

// creates the wiki based on the given `releaseNumber` variable
// (which is the workitem tag of `v1.1` in our case)

为什么我现在拥有的还不够好

如果我记得用正确的标签标记工作项，则该应用程序工作正常v1.1- 但如果我不这样做，该程序将不会发现特定票证（以及关联的分支/代码）已合并并已被合并的事实/ 正在等待发布 - 我希望这有意义吗？

问题

有没有办法让我获取已通过 REST api 合并到分支（或 git 标签）中的所有工作项（无论标签）？

我注意到还有一个azure-devops-node-apinpm 包可能合适，但我不知道我想要实现的目标是否可能。

为什么我不能使用 XYZ

我看到这个项目https://marketplace.visualstudio.com/items?itemName=richardfennellBM.BM-VSTS-XplatGenerateReleaseNotes，当我尝试它时，似乎工作正常，但不适合我的需求；

1. 我不使用releaseDevOps 中的专用部分，我只有几个应用程序管道，其中包含用于将各种应用程序部署到 QA/暂存/生产环境的门控步骤
2. 我在多个 Azure DevOps 管道中共享相同的版本号（并且上述解决方案（我发现）最适合单个管道）
3. 我不想将多个应用程序管道合并为一个主管道，除非我确实需要。

Answer 1

注意：我不会写如何做java脚本，因为我不是js专家......这个想法是rest api，所以语言并不重要。

1. 获取您想要检查的所有工作项，您可以使用当前的api来完成，只需在查询中删除标签即可。（您可以通过指定日期等缩小结果范围）

2. 您还需要获取链接到工作项的 PR，此数据无法通过WIQL api获得，因此 - 在获得需要的工作项 ID 后，调用工作项 - 获取工作项批次api（或循环每个项并执行工作项 - 获取工作项 api) 并$expand在正文/url 中添加用于relations/all获取链接 PR 的值。

3. 当您拥有带有链接 PR 的工作项后（在上面的 api 响应中，您将看到relations部分，如果其中包含，那么它url就是vstfs:///Git/PullRequestIdPR），您需要检查 PR 是否合并到分支master。如何？现在，使用Pull Requests - Get Pull Request api，检查此 PR 的目标分支并检查是否已完成（合并）。