Merge pull request #78 from reactiveops/rb/add-badges

add badges

.circleci/config.yml

@@ -45,7 +45,6 @@ jobs:
       - run: go get -u github.com/golang/lint/golint
       - run: go list ./... | grep -v vendor | xargs golint -set_exit_status
       - run: go list ./... | grep -v vendor | xargs go vet
-      - run: go test ./pkg/... -v -coverprofile cover.out
 
   test-deploy:
     docker:

.gitignore

@@ -11,8 +11,8 @@ polaris
 # Test binary, build with `go test -c`
 *.test
 
-# Output of the go coverage tool, specifically when used with LiteIDE
-*.out
+# Output of the go coverage tool
+/*.out
 
 Tiltfile
 main

README.md

@@ -1,6 +1,22 @@
-<p align="center">
+<div align="center">
   <img src="/pkg/dashboard/assets/images/polaris-logo.png" alt="Polaris Logo" />
-</p>
+  <br>
+  
+  [![Version][version-image]][version-link] [![CircleCI][circleci-image]][circleci-link] [![Go Report Card][goreport-image]][goreport-link]
+</div>
+
+[version-image]: https://img.shields.io/static/v1.svg?label=Version&message=0.1.0&color=239922
+[version-link]: https://github.com/reactiveops/polaris
+
+<!-- TODO: uncomment once project is public
+[circleci-image]: https://circleci.com/gh/reactiveops/polaris.svg?style=svg
+[goreport-image]: https://goreportcard.com/badge/github.com/reactiveops/polaris
+-->
+[circleci-link]: https://circleci.com/gh/reactiveops/polaris.svg
+[goreport-link]: https://goreportcard.com/report/github.com/reactiveops/polaris
+
+[circleci-image]: https://img.shields.io/static/v1.svg?label=Build&message=Passing&color=239922
+[goreport-image]: https://img.shields.io/static/v1.svg?label=go+report&message=A&color=239922
 
 Polaris keeps your cluster sailing smoothly. It runs a variety of checks to ensure that Kubernetes deployments are configured using best practices that will avoid potential problems in the future. The project includes two primary parts:
 

vendor/github.com/googleapis/gnostic/test/library-example-with-ext.text.out

@@ -0,0 +1,234 @@
+swagger: "2.0"
+info: <
+  title: "Google Example Library API"
+  version: "v1"
+  description: "A simple Google Example Library API."
+>
+host: "library-example.googleapis.com"
+paths: <
+  path: <
+    name: "/v1/{sharedParameter}/pets"
+    value: <
+      post: <
+        operation_id: "simpleMethod"
+        parameters: <
+          parameter: <
+            body_parameter: <
+              name: "myBodyRef"
+              in: "body"
+              schema: <
+                properties: <
+                  additional_properties: <
+                    name: "myStringA"
+                    value: <
+                      type: <
+                        value: "string"
+                      >
+                    >
+                  >
+                >
+              >
+            >
+          >
+        >
+        parameters: <
+          parameter: <
+            non_body_parameter: <
+              query_parameter_sub_schema: <
+                required: true
+                in: "query"
+                description: "New description"
+                name: "paramToOverride"
+                type: "string"
+              >
+            >
+          >
+        >
+        parameters: <
+          parameter: <
+            non_body_parameter: <
+              query_parameter_sub_schema: <
+                required: true
+                in: "query"
+                description: "test"
+                name: "paramAtSwaggerScope"
+                type: "integer"
+                format: "int32"
+              >
+            >
+          >
+        >
+        responses: <
+          response_code: <
+            name: "default"
+            value: <
+              response: <
+                description: "successful operation"
+                schema: <
+                  schema: <
+                    properties: <
+                      additional_properties: <
+                        name: "myStringA"
+                        value: <
+                          type: <
+                            value: "string"
+                          >
+                        >
+                      >
+                    >
+                  >
+                >
+              >
+            >
+          >
+        >
+      >
+      parameters: <
+        parameter: <
+          non_body_parameter: <
+            path_parameter_sub_schema: <
+              required: true
+              in: "path"
+              description: "Shared parameter"
+              name: "sharedParameter"
+              type: "string"
+            >
+          >
+        >
+      >
+      parameters: <
+        parameter: <
+          non_body_parameter: <
+            query_parameter_sub_schema: <
+              required: true
+              in: "query"
+              description: "Description to override"
+              name: "paramToOverride"
+              type: "string"
+            >
+          >
+        >
+      >
+    >
+  >
+>
+definitions: <
+  additional_properties: <
+    name: "SimpleDef"
+    value: <
+      properties: <
+        additional_properties: <
+          name: "myStringA"
+          value: <
+            type: <
+              value: "string"
+            >
+          >
+        >
+      >
+    >
+  >
+>
+parameters: <
+  additional_properties: <
+    name: "paramAtSwaggerScope"
+    value: <
+      non_body_parameter: <
+        query_parameter_sub_schema: <
+          required: true
+          in: "query"
+          description: "test"
+          name: "paramAtSwaggerScope"
+          type: "integer"
+          format: "int32"
+        >
+      >
+    >
+  >
+>
+vendor_extension: <
+  name: "x-sampleone-book"
+  value: <
+    value: <
+      type_url: "type.googleapis.com/sampleone.Book"
+      value: "\010{\020\347\007"
+    >
+    yaml: "code: 123\nmessage: 999\n"
+  >
+>
+vendor_extension: <
+  name: "x-sampleone-shelf"
+  value: <
+    value: <
+      type_url: "type.googleapis.com/sampleone.Shelf"
+      value: "\010{\020\347\007"
+    >
+    yaml: "foo1: 123\nbar: 999\n"
+  >
+>
+vendor_extension: <
+  name: "x-sampleone-mysimplestring"
+  value: <
+    value: <
+      type_url: "type.googleapis.com/google.protobuf.StringValue"
+      value: "\n\013hello world"
+    >
+    yaml: "hello world\n"
+  >
+>
+vendor_extension: <
+  name: "x-sampleone-mysimpleint64"
+  value: <
+    value: <
+      type_url: "type.googleapis.com/google.protobuf.StringValue"
+      value: "\n\00512345"
+    >
+    yaml: "12345\n"
+  >
+>
+vendor_extension: <
+  name: "x-sampleone-mysimplenumber"
+  value: <
+    value: <
+      type_url: "type.googleapis.com/google.protobuf.DoubleValue"
+      value: "\t\221\355|?5\316[@"
+    >
+    yaml: "111.222\n"
+  >
+>
+vendor_extension: <
+  name: "x-sampleone-mysimpleboolean"
+  value: <
+    value: <
+      type_url: "type.googleapis.com/google.protobuf.BoolValue"
+      value: "\010\001"
+    >
+    yaml: "true\n"
+  >
+>
+vendor_extension: <
+  name: "x-sampletwo-book"
+  value: <
+    value: <
+      type_url: "type.googleapis.com/sampletwo.Book"
+      value: "\010{\020\347\007"
+    >
+    yaml: "code: 123\nmessage: 999\n"
+  >
+>
+vendor_extension: <
+  name: "x-sampletwo-shelf"
+  value: <
+    value: <
+      type_url: "type.googleapis.com/sampletwo.Shelf"
+      value: "\010{\020\347\007"
+    >
+    yaml: "foo1: 123\nbar: 999\n"
+  >
+>
+vendor_extension: <
+  name: "x-unhandled"
+  value: <
+    yaml: "code: 123\nmessage: 999\n"
+  >
+>

vendor/github.com/googleapis/gnostic/test/v2.0/yaml/sample-petstore.out

@@ -0,0 +1,14 @@
+
+
+report.txt -------------------- 
+READING examples/v2.0/yaml/petstore.yaml (v2)
+Swagger: 2.0
+Host: petstore.swagger.io
+BasePath: /v1
+Info:
+  Title: Swagger Petstore
+  Version: 1.0.0
+Paths:
+  GET /pets
+  POST /pets
+  GET /pets/{petId}