Merge pull request #142 from justaprogrammer/more-docs

More documentation

Author: StanleyGoldman

docs/contributing.md

@@ -4,7 +4,7 @@
 1. Create a GitHub app
 
 ## Running Web Application
-1. [TODO Add Web Application instructions]
+1. [TODO: Add Web Application instructions]
 
 ## Running Integration Tests
 

docs/customizing.md

@@ -0,0 +1,61 @@
+# Customizing
+
+**Build Cross Check** is designed as a shortcut to allow anyone to create a [Check Run](https://developer.github.com/v3/checks/) 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](https://developer.github.com/v3/checks/runs/#create-a-check-run) operation in the GitHub Api.
+
+### CreateCheckRun <sub><sup>[src](https://github.com/justaprogrammer/BCC-Core/blob/master/src/BCC.Core/Model/CheckRunSubmission/CreateCheckRun.cs)</sup></sub>
+
+- 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 <sub><sup>[src](https://github.com/justaprogrammer/BCC-Core/blob/master/src/BCC.Core/Model/CheckRunSubmission/Annotation.cs)</sup></sub>
+
+- filename (string, required)
+- startLine (number, required)
+- endLine (number, required)
+- annotationLevel: notice, warning, failure (enum, required)
+- caption (string)
+
+### CheckRunImage <sub><sup>[src](https://github.com/justaprogrammer/BCC-Core/blob/master/src/BCC.Core/Model/CheckRunSubmission/CheckRunImage.cs)</sup></sub>
+
+- imageUrl (string, required)
+- alt (string, required)
+- caption (string)
+
+## Example Data
+
+Here is the output generated by **BCC-MSBuildLog** for [this](https://github.com/justaprogrammer/TestConsoleApp1/pull/1) Pull Request of `justaprogrammer/TestConsoleApp1`, our test application. It was used to generate [this](https://github.com/justaprogrammer/TestConsoleApp1/pull/1/checks?check_run_id=36879070) 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'
+}
+
+```

docs/integrating.md

@@ -46,8 +46,4 @@ This example is based on AppVeyor, but this will work from any CI system. For mo
    - IF NOT "%BCC_TOKEN%x"=="x" BCCSubmission -i checkrun.json -h %APPVEYOR_REPO_COMMIT% -t %BCC_TOKEN%
    ```
 
-1. Enjoy your warnings and errors.
-
-### Custom Check Run Data
-
-### More coming soon...
+1. Enjoy your warnings and errors.

docs/readme.md

@@ -3,4 +3,5 @@
 ## Table of Contents
 
 1. [Integrating](integrating.md)
+1. [Customizing](customizing.md)
 1. [Contributing](contributing.md)

src/BCC.Web.Tests/Util/FakerHelpers.cs

@@ -31,7 +31,7 @@ public static class FakerHelpers
                     filename: f.System.FileName(),
                     startLine: lineNumber,
                     endLine: lineNumber,
-                    checkWarningLevel: f.PickRandom<CheckWarningLevel>(),
+                    annotationLevel: f.PickRandom<AnnotationLevel>(),
                     message: f.Lorem.Word())
                 {
                     Title = f.Random.Words(3)

src/BCC.Web/BCC.Web.csproj

@@ -12,7 +12,7 @@
 
   <ItemGroup>
     <PackageReference Include="AspNet.Security.OAuth.GitHub" Version="2.0.0" />
-    <PackageReference Include="BCC-Core" Version="0.1.6" />
+    <PackageReference Include="BCC-Core" Version="0.1.7" />
     <PackageReference Include="BuildBundlerMinifier" Version="2.8.391" />
     <PackageReference Include="Castle.Core" Version="4.3.1" />
     <PackageReference Include="GitHubJwt" Version="0.0.3" />

src/BCC.Web/Services/GitHub/GitHubAppModelService.cs

@@ -6,7 +6,6 @@
 using MoreLinq.Extensions;
 using Octokit;
 using CheckRun = BCC.Web.Models.GitHub.CheckRun;
-using CheckWarningLevel = BCC.Core.Model.CheckRunSubmission.CheckWarningLevel;
 
 namespace BCC.Web.Services.GitHub
 {
@@ -193,13 +192,13 @@ public async Task<string> GetRepositoryFileAsync(string owner, string repository
 
         private static CheckAnnotationLevel GetCheckWarningLevel(Annotation annotation)
         {
-            switch (annotation.CheckWarningLevel)
+            switch (annotation.AnnotationLevel)
             {
-                case CheckWarningLevel.Notice:
+                case AnnotationLevel.Notice:
                     return CheckAnnotationLevel.Notice;
-                case CheckWarningLevel.Warning:
+                case AnnotationLevel.Warning:
                     return CheckAnnotationLevel.Warning;
-                case CheckWarningLevel.Failure:
+                case AnnotationLevel.Failure:
                     return CheckAnnotationLevel.Failure;
                 default:
                     throw new ArgumentOutOfRangeException();