Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-48670

Support DocFX JSON log in Violations Lib

XMLWordPrintable

      As requested in JENKINS-48669, I'm filing a sample DocFX log so you can make Violations Lib support it. The format is a series of JSON objects with newlines in between.

      The log file is written by C# code shown here: https://github.com/dotnet/docfx/blob/v2.28.2/src/Microsoft.DocAsCode.Common/Loggers/ReportLogListener.cs

      Notes on the properties of the JSON objects:

      • "message": The most important text.
      • "source": What the program was doing when it generated the log entry.
      • "file": The value in is bizarrely HTML-encoded. This property is not always present.
      • "line": This property is not always present.
      • "date_time": Always UTC.
      • "message_severity": Lower case.
      • "code": Seems to be an error code for grouping. This property is not always present.
      • "correlation_id": Consists of a GUID (random by default) and a hierarchical identifier. Does not seem useful to include in violation comments.

            tomasbjerre Tomas Bjerre
            kon Kalle Niemitalo
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: