annotations

README

Cirrus CI Annotations Parser

This module helps Cirrus CI to parse artifacts and find relative annotations to report in GitHub UI.

Supported Formats

• JUnit's XML
• GolangCI Lint
• Android Lint
• Ruby
  • RSpec
  • RuboCop
• Swift
  • XCLogParser
• JetBrains Qodana
• ESLint
• Boost
• Buf Lint

Create an issue to request support for other formats.

Cirrus Annotation Format

For tools that don't yet have their own annotation format, or for those that are wishing to simplify the integration process (to avoid adding a new parser), there's a simple streamed format they can use.

All you need to do is to emit JSON objects, one per line, where each describes a repository's file and what's gone wrong with it.

Here's an example:

{"level": "warning", "message": "use of os.SEEK_START is deprecated", "path": "main.go", "start_line": 35, "end_line": 35}
{"level": "failure", "message": "TestMain() failed!", "raw_details":  "main_test.go:18: expected a non-nil return", "path": "main_test.go", "start_line": 18, "end_line": 18}

Required fields:

• level — describes the severity of the annotation and results in different web UI rendering and build failure behavior
  • can be either notice, warning or failure
• message — a short description of what's gone wrong
• path — points to a file with the issue, relative to the repository's root
• start_line and end_line — the range of lines in path where the issue has happened
  • if your tool can only generate the information about a single line — simply set them both to that value

Optional fields:

• raw_details — an extension to the message that will be rendered as code and thus can contain multiple lines
• start_column and end_column — used to specify a more precise range than just using start_line and end_line

Contribution

Contributions are always welcome! 🎉🙌

Documentation

Index

• func NormalizeAnnotations(workDirPath string, annotations []model.Annotation) ([]model.Annotation, error)
• func ParseAnnotations(format string, path string) (error, []model.Annotation)

Functions

func NormalizeAnnotations

func NormalizeAnnotations(workDirPath string, annotations []model.Annotation) ([]model.Annotation, error)

func ParseAnnotations

func ParseAnnotations(format string, path string) (error, []model.Annotation)