Script 'Search commits' for github

Search commits

(Description borrowed from official documentation at https://github.com/octokit/plugin-rest-endpoint-methods.js/blob/master/docs/search/commits.md)

Find commits via various criteria on the default branch (usually master). This method returns up to 100 results per page.

When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

Created by lplit 992 days ago Viewed 43 times

Submitted by lplit Deno

Created 992 days ago

All edits

Permalink

import * as wmill from "https://deno.land/x/windmill@v1.34.0/mod.ts";
import { Octokit } from "https://cdn.skypack.dev/octokit?dts";

/*
@param: {wmill.Resource<"github">} gh_auth - Resource containing Github Auth API Key
example:
{
    auth: github_api_key
}
*/

export async function main(
  gh_auth: wmill.Resource<"github">,
  query: string,
  sort?: string,
  order?: string,
  per_page?: number,
  page?: number,
) {
  const octokit = new Octokit(gh_auth);
  const response = await octokit.rest.search.commits({
    q: query, sort: sort, order: order, per_page: per_page, page: page
  });

  return response;
}

`1`	`import * as wmill from "https://deno.land/x/windmill@v1.34.0/mod.ts";`
`2`	`import { Octokit } from "https://cdn.skypack.dev/octokit?dts";`
`3`
`4`	`/*`
`5`	`@param: {wmill.Resource<"github">} gh_auth - Resource containing Github Auth API Key`
`6`	`example:`
`7`	`{`
`8`	`auth: github_api_key`
`9`	`}`
`10`	`*/`
`11`
`12`	`export async function main(`
`13`	`gh_auth: wmill.Resource<"github">,`
`14`	`query: string,`
`15`	`sort?: string,`
`16`	`order?: string,`
`17`	`per_page?: number,`
`18`	`page?: number,`
`19`	`) {`
`20`	`const octokit = new Octokit(gh_auth);`
`21`	`const response = await octokit.rest.search.commits({`
`22`	`q: query, sort: sort, order: order, per_page: per_page, page: page`
`23`	`});`
`24`
`25`	`return response;`
`26`	`}`