@probot/octokit-plugin-config
Version:
Get/set persisted configuration using YAML/JSON files in repositories
21 lines (20 loc) • 698 B
TypeScript
import type { Octokit } from "@octokit/core";
import type { ConfigFile } from "../types.js";
type Options = {
owner: string;
repo: string;
path: string;
branch?: string | undefined;
};
/**
* Load configuration from selected repository file. If the file does not exist
* it loads configuration from the owners `.github` repository.
*
* If the repository file configuration includes an `_extends` key, that file
* is loaded. Same with the target file until no `_extends` key is present.
*
* @param octokit Octokit instance
* @param options
*/
export declare function getConfigFiles(octokit: Octokit, { owner, repo, path, branch }: Options): Promise<ConfigFile[]>;
export {};