release-it
- Version 17.10.0
- Published
- 264 kB
- 24 dependencies
- MIT license
Install
npm i release-it
yarn add release-it
pnpm add release-it
Overview
Generic CLI tool to automate versioning and package publishing-related tasks.
Index
Interfaces
interface Config
interface Config {}
property git
git?: { /** @default "git log --pretty=format:\"* %s (%h)\" ${from}...${to}" */ changelog?: string;
/** @default true */ requireCleanWorkingDir?: boolean;
/** @default false */ requireBranch?: false | string;
/** @default true */ requireUpstream?: boolean;
/** @default false */ requireCommits?: boolean;
/** @default true */ requireCommitsFail?: boolean;
/** @default "" */ commitsPath?: string;
/** @default false */ addUntrackedFiles?: boolean;
/** @default true */ commit?: boolean;
/** @default "Release ${version}" */ commitMessage?: string;
commitArgs?: Array<any>;
/** @default true */ tag?: boolean;
/** @default null */ tagExclude?: any;
/** @default null */ tagName?: any;
/** @default null */ tagMatch?: any;
/** @default false */ getLatestTagFromAllRefs?: boolean;
/** @default "Release ${version}" */ tagAnnotation?: string;
tagArgs?: Array<any>;
/** @default true */ push?: boolean;
/** @default ["--follow-tags"] */ pushArgs?: Array<string>;
/** @default "" */ pushRepo?: string;};
property github
github?: { /** @default false */ release?: boolean;
/** @default "Release ${version}" */ releaseName?: string;
/** @default null */ releaseNotes?: any;
/** @default false */ autoGenerate?: boolean;
/** @default false */ preRelease?: boolean;
/** @default false */ draft?: boolean;
/** @default "GITHUB_TOKEN" */ tokenRef?: string;
/** @default null */ assets?: any;
/** @default null */ host?: any;
/** @default 0 */ timeout?: number;
/** @default null */ proxy?: any;
/** * @default true * 'legacy' - Github determines the latest release based on the release creation date and higher semantic version. * See https://docs.github.com/en/rest/releases/releases?apiVersion=latest#create-a-release */ makeLatest?: boolean | 'legacy';
/** @default false */ discussionCategoryName?: boolean | string;
/** @default false */ skipChecks?: boolean;
/** @default false */ web?: boolean;
comments?: { /** @default false */ submit?: boolean;
/** @default ":rocket?: _This issue has been resolved in v${version}. See [${releaseName}](${releaseUrl}) for release notes._" */ issue?: string;
/** @default ":rocket?: _This pull request is included in v${version}. See [${releaseName}](${releaseUrl}) for release notes._" */ pr?: string; };};
property gitlab
gitlab?: { /** @default false */ release?: boolean;
/** @default "Release ${version}" */ releaseName?: string;
/** @default null */ releaseNotes?: any;
milestones?: Array<any>;
/** @default "GITLAB_TOKEN" */ tokenRef?: string;
/** @default "Private-Token" */ tokenHeader?: string;
/** @default null */ certificateAuthorityFile?: any;
/** @default null */ secure?: boolean;
/** @default null */ assets?: any;
/** @default false */ useIdsForUrls?: boolean;
/** @default null */ origin?: any;
/** @default false */ skipChecks?: boolean;};
property hooks
hooks?: Hooks;
property npm
npm?: { /** @default true */ publish?: boolean;
/** @default "." */ publishPath?: string;
publishArgs?: Array<any>;
/** @default null */ tag?: any;
/** @default null */ otp?: any;
/** @default false */ ignoreVersion?: boolean;
/** @default false */ allowSameVersion?: boolean;
versionArgs?: Array<any>;
/** @default false */ skipChecks?: boolean;
/** @default 10 */ timeout?: number;};
property plugins
plugins?: Record<string, Record<string, any>>;
Package Files (2)
Dependencies (24)
Dev Dependencies (24)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/release-it
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/release-it)
- HTML<a href="https://www.jsdocs.io/package/release-it"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 2547 ms. - Missing or incorrect documentation? Open an issue for this package.