这个想法
我目前正在使用NodeJS开发一个“发布说明”应用程序,它调用各种Azure DevOps REST API终端点,以根据特定标签获取工作项。
我现在拥有的
我目前所拥有的工作方式如下:
- 某些 Azure DevOps上的工作项被(定制)标记为
v1.1
。 - 我编写的JS函数可以获取所有匹配给定
v1.1
标签的工作项。 - 使用生成的Markdown创建了一个Wiki条目,显示每个工作项的详细信息(格式对问题不重要)。
/**
* 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-api
npm包,可能适用,但我不知道我要实现的目标是否可行。
为什么我不能使用XYZ
我看到了这个项目https://marketplace.visualstudio.com/items?itemName=richardfennellBM.BM-VSTS-XplatGenerateReleaseNotes,试用后似乎可以正常工作,但不适合我的需求,因为:
- 我没有在 DevOps 中使用专用的
release
部分,我只有几个包含门控步骤以将各种应用程序部署到 QA / Staging / Production 环境的应用程序管道 - 我在多个 Azure DevOps 管道中共享相同的发布号码(我找到的上述解决方案最适用于单个管道)
- 除非我真的需要,否则我不想将几个应用程序管道合并为单个主管道。