fix: update probot to 10 (#70)

package.json

@@ -30,7 +30,7 @@
     "gitdiff-parser": "^0.2.2",
     "js-yaml": "^3.14.0",
     "minimatch": "^3.0.4",
-    "probot": "^9.13.0"
+    "probot": "^10.2.0"
   },
   "devDependencies": {
     "@rollup/plugin-node-resolve": "^9.0.0",

src/annotate.test.ts

@@ -18,7 +18,6 @@ import { annotate, getLevelFromAnnotations } from "./annotate";
 
 import { DEFAULT_CONFIGURATION } from "./config";
 import { Level } from "./rules";
-import { Octokit } from "@octokit/rest/";
 import fs from "fs";
 import { parse } from "./parse";
 
@@ -83,6 +82,6 @@ test("should get correct level from annotations", () => {
       { annotation_level: "notice" },
       { annotation_level: "warning" },
       { annotation_level: "failure" },
-    ] as Octokit.ChecksUpdateParamsOutputAnnotations[])
+    ] as any)
   ).toBe(Level.FAILURE);
 });

src/annotate.ts

@@ -13,18 +13,28 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 import { Configuration } from "./config";
 import { File } from "gitdiff-parser";
 import { Level } from "./rules";
-import { Octokit } from "@octokit/rest/";
 import minimatch from "minimatch";
 
+export type ChecksUpdateParamsOutputAnnotations = {
+  path: string;
+  start_line: number;
+  end_line: number;
+  start_column?: number;
+  end_column?: number;
+  annotation_level: "notice" | "warning" | "failure";
+  message: string;
+  title?: string;
+  raw_details?: string;
+};
+
 export const annotate = (
   config: Configuration,
   files: File[]
-): Octokit.ChecksUpdateParamsOutputAnnotations[] => {
-  const annotations: Octokit.ChecksUpdateParamsOutputAnnotations[] = [];
+): ChecksUpdateParamsOutputAnnotations[] => {
+  const annotations: ChecksUpdateParamsOutputAnnotations[] = [];
 
   for (const f of files) {
     if (
@@ -69,7 +79,7 @@ export const annotate = (
 const levels = [Level.OFF, Level.NOTICE, Level.WARNING, Level.FAILURE];
 
 export const getLevelFromAnnotations = (
-  annotations: Octokit.ChecksUpdateParamsOutputAnnotations[]
+  annotations: ChecksUpdateParamsOutputAnnotations[]
 ): Level => {
   let level = Level.OFF;
 

src/solidarity.test.ts

@@ -16,9 +16,8 @@
 
 import { Conclusion, OutputTitle, Solidarity } from "./solidarity";
 
-import { Context } from "probot";
 import { DEFAULT_CONFIGURATION } from "./config";
-import { LoggerWithTarget } from "probot/lib/wrap-logger";
+import { Logger } from "probot";
 import fs from "fs";
 import { parse } from "./parse";
 
@@ -29,8 +28,8 @@ const failingDIff = parse(
 
 test("solidarity should run check on failing diff", async () => {
   const s = new Solidarity(
-    { name: "foo", id: "bar", payload: payload } as Context,
-    ({ info: jest.fn() } as unknown) as LoggerWithTarget
+    { name: "foo", id: "bar", payload: payload } as any,
+    ({ info: jest.fn() } as unknown) as Logger
   );
 
   s.diff = jest.fn().mockReturnValue(failingDIff);
@@ -44,8 +43,8 @@ test("solidarity should run check on failing diff", async () => {
 
 test("solidarity should have correct properties from payload", async () => {
   const s = new Solidarity(
-    { name: "foo", id: "bar", payload: payload } as Context,
-    ({ info: jest.fn() } as unknown) as LoggerWithTarget
+    { name: "foo", id: "bar", payload: payload } as any,
+    ({ info: jest.fn() } as unknown) as Logger
   );
   expect(s.owner).toEqual("jpoehnelt");
   expect(s.repo).toEqual("in-solidarity-bot");

src/solidarity.ts

@@ -14,17 +14,28 @@
  * limitations under the License.
  */
 
+import {
+  ChecksUpdateParamsOutputAnnotations,
+  annotate,
+  getLevelFromAnnotations,
+} from "./annotate";
 import { Configuration, InvalidConfigError, getConfig } from "./config";
-import { annotate, getLevelFromAnnotations } from "./annotate";
+import { Context, Logger } from "probot";
 
-import { Context } from "probot";
 import { File } from "gitdiff-parser";
 import { Level } from "./rules";
-import { LoggerWithTarget } from "probot/lib/wrap-logger";
-import { Octokit } from "@octokit/rest/";
+import { RestEndpointMethodTypes } from "@octokit/plugin-rest-endpoint-methods";
 import fs from "fs";
 import { parse } from "./parse";
 
+type ChecksCreateParams = RestEndpointMethodTypes["checks"]["create"]["parameters"];
+
+export type ChecksUpdateParamsOutput = {
+  title: string;
+  summary: string;
+  annotations?: ChecksUpdateParamsOutputAnnotations[];
+};
+
 const SUMMARY = fs.readFileSync("./static/HELP.md", "utf8");
 const CHECK_NAME = "Inclusive Language";
 
@@ -48,11 +59,11 @@ export enum OutputTitle {
 
 export class Solidarity {
   private context: Context;
-  private logger: LoggerWithTarget;
+  private logger: Logger;
   private checkId?: number;
   config?: Configuration;
 
-  constructor(context: Context, logger: LoggerWithTarget) {
+  constructor(context: Context, logger: Logger) {
     this.context = context;
     this.logger = logger;
   }
@@ -73,7 +84,7 @@ export class Solidarity {
     return this.context.payload.number;
   }
 
-  get checkOptions(): Octokit.ChecksCreateParams {
+  get checkOptions(): ChecksCreateParams {
     return {
       owner: this.owner,
       repo: this.repo,
@@ -84,14 +95,14 @@ export class Solidarity {
 
   async run(): Promise<void> {
     let conclusion: Conclusion = Conclusion.NEUTRAL;
-    let output: Octokit.ChecksUpdateParamsOutput;
+    let output: { title: string; summary: string };
 
     await this.start();
     await this.update("in_progress");
 
     try {
       this.config = await getConfig(this.context);
-      this.logger.info(this.config);
+      this.logger.info(this.config, "Loaded config");
     } catch (e) {
       if (e instanceof InvalidConfigError) {
         conclusion = Conclusion.FAILURE;
@@ -170,7 +181,7 @@ export class Solidarity {
   async update(
     status: "queued" | "in_progress" | "completed",
     conclusion?: Conclusion,
-    output?: Octokit.ChecksUpdateParamsOutput,
+    output?: ChecksUpdateParamsOutput,
     details_url?: string
   ): Promise<void> {
     try {
@@ -205,10 +216,10 @@ export class Solidarity {
 
   async check(): Promise<{
     conclusion: Conclusion;
-    output: Octokit.ChecksUpdateParamsOutput;
+    output: ChecksUpdateParamsOutput;
   }> {
     let conclusion: Conclusion;
-    const output: Octokit.ChecksUpdateParamsOutput = {
+    const output: ChecksUpdateParamsOutput = {
       title: CHECK_NAME,
       summary: SUMMARY,
     };

tsconfig.json

@@ -15,7 +15,7 @@
     "noImplicitAny": false,
     "esModuleInterop": true,
     "declaration": true,
-    "resolveJsonModule": true
+    "resolveJsonModule": true,
   },
   "include": [
     "src/**/*"