@qiwi/semantic-release-gh-pages-plugin
- Version 5.2.8
- Published
- 82.7 kB
- 16 dependencies
- MIT license
Install
npm i @qiwi/semantic-release-gh-pages-plugin
yarn add @qiwi/semantic-release-gh-pages-plugin
pnpm add @qiwi/semantic-release-gh-pages-plugin
Overview
gh-pages publishing plugin for semantic-release
Index
Namespaces
Namespaces
namespace @qiwi/semantic-release-gh-pages-plugin
module '@qiwi/semantic-release-gh-pages-plugin' {}
variable DEFAULT_BRANCH
const DEFAULT_BRANCH: string;
variable DEFAULT_DST
const DEFAULT_DST: string;
variable DEFAULT_ENTERPRISE
const DEFAULT_ENTERPRISE: boolean;
variable DEFAULT_MSG
const DEFAULT_MSG: string;
variable DEFAULT_PULL_TAGS_BRANCH
const DEFAULT_PULL_TAGS_BRANCH: string;
variable DEFAULT_SRC
const DEFAULT_SRC: string;
variable PLUGIN_PATH
const PLUGIN_PATH: string;
semantic-release-gh-pages-plugin
function publish
publish: (pluginConfig: any, context: TContext) => Promise<unknown>;
function verifyConditions
verifyConditions: (pluginConfig: any, context: TContext) => Promise<void>;
namespace @qiwi/semantic-release-gh-pages-plugin/target/es5
module '@qiwi/semantic-release-gh-pages-plugin/target/es5' {}
variable _default
const _default: { verifyConditions: (pluginConfig: any, context: TContext) => Promise<void>; publish: (pluginConfig: any, context: TContext) => Promise<unknown>;};
variable DEFAULT_BRANCH
const DEFAULT_BRANCH: string;
variable DEFAULT_DST
const DEFAULT_DST: string;
variable DEFAULT_ENTERPRISE
const DEFAULT_ENTERPRISE: boolean;
variable DEFAULT_MSG
const DEFAULT_MSG: string;
variable DEFAULT_PULL_TAGS_BRANCH
const DEFAULT_PULL_TAGS_BRANCH: string;
variable DEFAULT_SRC
const DEFAULT_SRC: string;
variable PLUGIN_PATH
const PLUGIN_PATH: string;
semantic-release-gh-pages-plugin
function publish
publish: (pluginConfig: any, context: TContext) => Promise<unknown>;
function verifyConditions
verifyConditions: (pluginConfig: any, context: TContext) => Promise<void>;
namespace @qiwi/semantic-release-gh-pages-plugin/target/es5/defaults
module '@qiwi/semantic-release-gh-pages-plugin/target/es5/defaults' {}
variable DEFAULT_BRANCH
const DEFAULT_BRANCH: string;
variable DEFAULT_DST
const DEFAULT_DST: string;
variable DEFAULT_ENTERPRISE
const DEFAULT_ENTERPRISE: boolean;
variable DEFAULT_MSG
const DEFAULT_MSG: string;
variable DEFAULT_PULL_TAGS_BRANCH
const DEFAULT_PULL_TAGS_BRANCH: string;
variable DEFAULT_SRC
const DEFAULT_SRC: string;
variable PLUGIN_PATH
const PLUGIN_PATH: string;
semantic-release-gh-pages-plugin
namespace @qiwi/semantic-release-gh-pages-plugin/target/es5/interface
module '@qiwi/semantic-release-gh-pages-plugin/target/es5/interface' {}
interface IGhpagesPluginConfig
interface IGhpagesPluginConfig {}
property add
add?: boolean;
property ciBranch
ciBranch: string;
property docsBranch
docsBranch: string;
property dotfiles
dotfiles?: boolean;
property dst
dst: string;
property enterprise
enterprise?: boolean;
property msg
msg: string;
property pullTagsBranch
pullTagsBranch?: string;
property repo
repo: string;
property src
src: string;
property token
token?: string;
interface ILogger
interface ILogger {}
interface IPushOpts
interface IPushOpts extends IGhpagesPluginConfig {}
type TAnyMap
type TAnyMap = { [key: string]: any;};
type TContext
type TContext = Context & { env: TStringMap; branch?: Exclude<BranchSpec, string>; cwd: string; options: TAnyMap & { publish?: Array<any>; verifyConditions?: Array<any>; };};
type TStringMap
type TStringMap = { [key: string]: string;};
namespace @qiwi/semantic-release-gh-pages-plugin/target/es6
module '@qiwi/semantic-release-gh-pages-plugin/target/es6' {}
variable _default
const _default: { verifyConditions: (pluginConfig: any, context: TContext) => Promise<void>; publish: (pluginConfig: any, context: TContext) => Promise<unknown>;};
variable DEFAULT_BRANCH
const DEFAULT_BRANCH: string;
variable DEFAULT_DST
const DEFAULT_DST: string;
variable DEFAULT_ENTERPRISE
const DEFAULT_ENTERPRISE: boolean;
variable DEFAULT_MSG
const DEFAULT_MSG: string;
variable DEFAULT_PULL_TAGS_BRANCH
const DEFAULT_PULL_TAGS_BRANCH: string;
variable DEFAULT_SRC
const DEFAULT_SRC: string;
variable PLUGIN_PATH
const PLUGIN_PATH: string;
semantic-release-gh-pages-plugin
function publish
publish: (pluginConfig: any, context: TContext) => Promise<unknown>;
function verifyConditions
verifyConditions: (pluginConfig: any, context: TContext) => Promise<void>;
namespace @qiwi/semantic-release-gh-pages-plugin/target/es6/defaults
module '@qiwi/semantic-release-gh-pages-plugin/target/es6/defaults' {}
variable DEFAULT_BRANCH
const DEFAULT_BRANCH: string;
variable DEFAULT_DST
const DEFAULT_DST: string;
variable DEFAULT_ENTERPRISE
const DEFAULT_ENTERPRISE: boolean;
variable DEFAULT_MSG
const DEFAULT_MSG: string;
variable DEFAULT_PULL_TAGS_BRANCH
const DEFAULT_PULL_TAGS_BRANCH: string;
variable DEFAULT_SRC
const DEFAULT_SRC: string;
variable PLUGIN_PATH
const PLUGIN_PATH: string;
semantic-release-gh-pages-plugin
namespace @qiwi/semantic-release-gh-pages-plugin/target/es6/interface
module '@qiwi/semantic-release-gh-pages-plugin/target/es6/interface' {}
interface IGhpagesPluginConfig
interface IGhpagesPluginConfig {}
property add
add?: boolean;
property ciBranch
ciBranch: string;
property docsBranch
docsBranch: string;
property dotfiles
dotfiles?: boolean;
property dst
dst: string;
property enterprise
enterprise?: boolean;
property msg
msg: string;
property pullTagsBranch
pullTagsBranch?: string;
property repo
repo: string;
property src
src: string;
property token
token?: string;
interface ILogger
interface ILogger {}
interface IPushOpts
interface IPushOpts extends IGhpagesPluginConfig {}
type TAnyMap
type TAnyMap = { [key: string]: any;};
type TContext
type TContext = Context & { env: TStringMap; branch?: Exclude<BranchSpec, string>; cwd: string; options: TAnyMap & { publish?: Array<any>; verifyConditions?: Array<any>; };};
type TStringMap
type TStringMap = { [key: string]: string;};
Package Files (1)
Dependencies (16)
Dev Dependencies (14)
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/@qiwi/semantic-release-gh-pages-plugin
.
- Markdown[](https://www.jsdocs.io/package/@qiwi/semantic-release-gh-pages-plugin)
- HTML<a href="https://www.jsdocs.io/package/@qiwi/semantic-release-gh-pages-plugin"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 4513 ms. - Missing or incorrect documentation? Open an issue for this package.