Azure / azure-sdk-tools

Tools repository leveraged by the Azure SDK team.
MIT License
114 stars 180 forks source link

.NET branding is wrong in PR bot #6924

Open heaths opened 1 year ago

heaths commented 1 year ago

Please use proper branding at least for first-party applications: ".Net" -> ".NET":

image
kurtzeborn commented 1 year ago

This is messaging added by the pipeline bot I believe.

konrad-jamrozik commented 1 year ago

The language string is in APIViewInfo. See here:

let apiViews : APIViewInfo[] = (context.pr.apiViewsSDK ?? []).concat(context.pr.apiViewsSpecs ?? []);
(...)
const commentBody = generateApiViewComment({ title: apiViewCommentGroup.title, apiViews });

language is set in addEventToApiViewsIfNotAlreadyPresent:

apiViews.push({
  language: event.language,
  packageName: event.packageName,
  apiViewLink: event.apiViewLink,
  errorMessage: event.errorMessage,
});

where event: ApiViewEvent.

It comes from here

event.status === "apiview"

which comes e.g. from GenerateApiView task:

{"level":"info","message":"EventHubProducer.send: FQN/eventHubName: openapi-platform-events.servicebus.windows.net/pipeline-events, events: {\"status\":\"apiview\",\"env\":\"prod\",\"source\":\"github\",\"pipelineJobStageName\":\"AzureRestApiSpecsPipeline\",\"unifiedPipelineTaskKey\":\"ApiView\",\"unifiedPipelineBuildId\":\"43db1861-7254-4efe-92ba-877fc5ba8b98\",\"apiViewLink\":\"https://apiview.dev/Assemblies/Review/4a9364b6707641cb9062ee42cc79dc56\",\"language\":\"Swagger\",\"packageName\":\"Microsoft.DigitalTwins\"}"}

There is also TypeSpecAPIView but I am not sure if it means there are more strings to fix.

@chidozieononiwu @praveenkuttappan I am assigning this to you as it looks to me the string originates from within API View.