Migration Guide or updated and extended version of a typescript example

[jimjaeger]

``With the update to Probot 13 the typescript checking bring a lot more errors because types became of incompatible types.
Unfortunately I could not find any migration guide.

Does anybody know how to defines types correctly used from probot and the underlaying octokit?

Here some example:

1. Call Update Check Run - single value:

const conclusion: ???? = ;

return octokit.checks.update({
      ...sourceCheckRun,
      check_run_id: sourceCheckRun.id,
      status: "completed",
      conclusion: conclusion,
      completed_at,
      output: {
        title: sourceCheckRun.output.title || "N/A",
        summary,
        text,
        annotations
      },
      mediaType: checkrunMedia
    });

--> What is the best way to type for the conclusion value?

2. Call Update Check Run - complete Input:

`
  const input: ??? = {
    ...sourceCheckRun,
    check_run_id: sourceCheckRun.id,
    status: "in_progress",
    started_at: startTime,
    output: {
      title: sourceCheckRun.output.title,
      summary: `summary`
    },
    mediaType: checkrunMedia
  };
  delete input['conclusion'];
  delete input['completed_at'];
  return octokit.checks.update(input);

--> What is the best way to type for the complete input value?

[wolfy1339]

What types were you using before? The method of getting those types hasn't changed in Octokit

import type { RestEndpointMethodTypes } from '@octokit/plugin-rest-endpoint-methods';
type ChecksUpdateParams = RestEndpointMethodTypes["checks"]["update"]["parameters"];

const input: ChecksUpdateParams = {
    // Add parameters here
};
const conclusion: ChecksUpdateParams['conclusion'] = "success";

[jimjaeger]

Thanks that helped.

To answer your question. I did not use an explicit type. I used the response data of the create check request to fill the input and it worked before. But it looks like with types update in the dependency chain it became invalid. May it does not come directly from probot changes but from probots dependency updates.

[jimjaeger]

I am still interested in a migration guide, because there are some ugly changes like the webhook property change or an issue with signature check (I will open a new thread).

[wolfy1339]

What is this issue with the webhook property?

[jimjaeger]

Version 13. changes the default. I did not find any information about the change,, impact or what a application owner has to do when uprading in the documentation, only in the github tags information. A upgrade ended a broken application in which a already configured github app configuration results in an error because the application does not receive the events on the previous default path. After setting the property to the previous value it begin to work again.

[wolfy1339]

All the breaking changes are listed in the release notes. Feel free to submit a PR to make a migration guide.