UNPKG

@auto-it/omit-release-notes

Version:

Omit release notes plugin for auto

35 lines 1.24 kB
import { Auto, IPlugin } from "@auto-it/core"; import * as t from "io-ts"; declare const pluginOptions: t.PartialC<{ /** Usernames to omit */ username: t.UnionC<[t.StringC, t.ArrayC<t.StringC>]>; /** Emails to omit */ email: t.UnionC<[t.StringC, t.ArrayC<t.StringC>]>; /** Names to omit */ name: t.UnionC<[t.StringC, t.ArrayC<t.StringC>]>; /** Labels to omit */ labels: t.UnionC<[t.StringC, t.ArrayC<t.StringC>]>; }>; export declare type IReleaseNotesPluginOptions = t.TypeOf<typeof pluginOptions>; /** Filter PRs with release notes that shouldn't make it into a release. */ export default class ReleaseNotesPlugin implements IPlugin { /** The name of the plugin */ name: string; /** The options of the plugin */ readonly options: { /** Usernames to omit */ username: string[]; /** Emails to omit */ email: string[]; /** Names to omit */ name: string[]; /** Labels to omit */ labels: string[]; }; /** Initialize the plugin with it's options */ constructor(options: IReleaseNotesPluginOptions); /** Tap into auto plugin points. */ apply(auto: Auto): void; } export {}; //# sourceMappingURL=index.d.ts.map