customizing.md

Customizing

Build Cross Check is designed as a shortcut to allow anyone to create a Check Run from their build process. Check Runs are always created with a status of Completed.

Schema

The data structure and rules mimic the Create Check Run operation in the GitHub Api.

CreateCheckRun _^src

• name (string, required) - The name of the Check Run
• title (string, required) - The title of the Check Run
• summary (string, required) - The summary of the Check Run, supports Markdown
• text (string) - The details of the Check Run, supports Markdown
• conclusion: success, failure, neutral, cancelled, timedOut, actionRequired (enum, required)
• annotations (array[Annotation])
• images (array[CheckRunImage])
• startedAt (string, required)
• completedAt (string, required)

Annotation _^src

• filename (string, required)
• startLine (number, required)
• endLine (number, required)
• annotationLevel: notice, warning, failure (enum, required)
• caption (string)

CheckRunImage _^src

• imageUrl (string, required)
• alt (string, required)
• caption (string)

Example Data

Here is the output generated by BCC-MSBuildLog for this Pull Request of justaprogrammer/TestConsoleApp1, our test application. It was used to generate this Check Run.

{
	'name': 'MSBuild Log',
	'title': '0 errors - 1 warning',
	'summary': '- [TestConsoleApp1/Program.cs(13)](https://github.com/justaprogrammer/TestConsoleApp1/tree/815aa7a3051cc0d0ae6c6c2c89cba125e8027d86/TestConsoleApp1/Program.cs#L13) **Warning - CS0219** The variable \'hello\' is assigned but its value is never used\r\n',
	'text': null,
	'conclusion': 'success',
	'annotations': [{
			'filename': 'TestConsoleApp1/Program.cs',
			'checkWarningLevel': 'warning',
			'title': 'CS0219: TestConsoleApp1/Program.cs(13)',
			'rawDetails': null,
			'message': 'The variable 'hello' is assigned but its value is never used',
			'startLine': 13,
			'endLine': 13
		}
	],
	'images': null,
	'startedAt': '2018-12-07T08:39:22.5858425-05:00',
	'sompletedAt': '2018-12-07T08:39:22.6347882-05:00'
}

Submitting data

Check our swagger doc for information.