@auto-canary/omit-commits
Version:
Omit commits plugin for auto
36 lines • 1.15 kB
TypeScript
import { Auto, IPlugin } from '@auto-it/core';
export interface IOmitCommitsPluginOptions {
/** Usernames to omit */
username?: string | string[];
/** Emails to omit */
email?: string | string[];
/** Names to omit */
name?: string | string[];
/** Commit messages to omit */
subject?: string | string[];
/** Labels to omit */
labels?: string | string[];
}
/** Filter certain commits out of the changelog and version calculation. */
export default class OmitCommitsPlugin 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[];
/** Commit messages to omit */
subject: string[];
/** Labels to omit */
labels: string[];
};
/** Initialize the plugin with it's options */
constructor(options: IOmitCommitsPluginOptions);
/** Tap into auto plugin points. */
apply(auto: Auto): void;
}
//# sourceMappingURL=index.d.ts.map