Publishing release notes to TFS/VSTS Wiki during Release

Question

My mission is to generate and publish release notes on WIKI automatically when ever the release triggered, for this I am following this Blog, its very handy blog, but my bad luck still not able to create wiki page with release template. (using both Azure DevOps and TFS)

Template:

**Build Number**  : $($build.buildnumber)    
**Build started** : $("{0:dd/MM/yy HH:mm:ss}" -f [datetime]$build.startTime)     
**Source Branch** : $($build.sourceBranch)  
###Associated work items  
@@WILOOP@@  
* #$($widetail.id)
@@WILOOP@@  
###Associated change sets/commits  
@@CSLOOP@@  
* **ID $($csdetail.changesetid)$($csdetail.commitid)** 
  >$($csdetail.comment)    
@@CSLOOP@@

PowerShell Script

$content = [IO.File]::ReadAllText("$(System.DefaultWorkingDirectory)\releasenotes.md")
$data = @{content=$content;} | ConvertTo-Json;
$params = @{uri = '$(WikiPath)';
  Method = 'PUT';
  Headers = @{Authorization = "Bearer $(System.AccessToken)" };
  ContentType = "application/json";
  Body = $data;
}
Invoke-WebRequest @params

Please guide me what I am doing wrong

Shamrai Aleksander · Answer 1 · 2021-02-08T15:21:07.617

1

Check access to System.AccessToken on the job level: https://learn.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=classic

Additionally, check permissions on your wiki

edited Feb 08 '21 at 15:21

answered Feb 08 '21 at 14:06

Shamrai Aleksander

13,096
3
24
31

Nice catch, now my log shows Status Code:200 and Status Description: OK, but still WIKI page is not created :( would you please share me the value of $(WikiPath) consumed in PS script – Saad Awan Feb 08 '21 at 14:20
@SaadAwan, I did not use this extension and can just suggest some ideas )). Check permissions of build services on the wiki security. – Shamrai Aleksander Feb 08 '21 at 15:23

score 1 · Accepted Answer · answered Feb 09 '21 at 03:38

After testing, we find that the PowerShell script in your mentioned blog uses this Rest API: Pages - Create Or Update, thus the wikipath is the requested url like below format:

https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}/pages?path={path}&api-version=6.0

For example, we create a project wiki named scrum-test.wiki, and want to create a new wiki page named Release notes, the url would like below

https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/scrum-test.wiki/pages?path=Release notes&api-version=6.0

If we now want to create a child wiki page named 0.1.0 under Release notes page, the url would be like below

https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/scrum-test.wiki/pages?path=Release notes/0.1.0&api-version=6.0

In addition, using AccessToken we always get error which says that "The wiki page operation failed with message : User does not have write permissions for this wiki." even we grant full wiki permissions for identity: {project name} Build Service ({organization name}), so we use PAT authentication with full access and it works fine with below PowerShell script.

$content = [IO.File]::ReadAllText("$(System.DefaultWorkingDirectory)\releasenotes.md")
$data = @{content=$content;} | ConvertTo-Json;

$connectionToken="PAT here"

$base64AuthInfo= [System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes(":$($connectionToken)"))

$params = @{uri = '$(WikiPath)';
  Method = 'PUT';
  Headers = @{Authorization = "Basic $base64AuthInfo" };
  ContentType = "application/json";
  Body = $data;
}
Invoke-WebRequest @params

Thanks all, $(WikiPath) was the problem, corrected the link and now able to create the wikis pages as expected, — Saad Awan, Feb 09 '21 at 07:28

Publishing release notes to TFS/VSTS Wiki during Release

2 Answers2