Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 1.3 KB

README.md

File metadata and controls

35 lines (25 loc) · 1.3 KB
Raw

Description

Release notes generator for SonarSource projects hosted on GitHub

Use

Visit:

https://sonar-dotnet-rel-notes.azurewebsites.net/api/gen?r=<repository>&m=<milestone>&t=<token>

Replace:

  • repository with a repository name, including owner, for example SonarSource/sonar-dotnet
  • milestone with a milestone name, for example 7.10
  • token GitHub token that has read access to the repository

Example

https://sonar-dotnet-rel-notes.azurewebsites.net/api/gen?r=SonarSource/sonar-dotnet&m=7.10&t=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Notes

Currently works with the SonarC#/VB.NET and SonarLint for Visual Studio labels

How to publish

  1. Right click the "ReleaseNotes" project, choose "Publish..."
  2. In the Publish window, click the profile dropdown, choose "sonar-dotnte-rel-notes - Zip Deploy"
  3. Click the Publish button (you might need to authenticate at some point, use your SonarSource Visual Studio account)

Future

  • Store the GitHub token on Azure, to avoid the need to provide it through the url
  • Improve the error message when required request parameters are missing
  • Implement per-repository configuration and avoid hardcoding repository-specific labels. For example the Azure function could read the mappings from a file at well known location in the repository.