semantic-release-npm-deprecate
Version:
Semantic Release NPM Deprecate Plugin
32 lines (31 loc) • 1.33 kB
TypeScript
/**
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Context } from "semantic-release";
export interface Deprecation {
version: string;
message: string;
}
export interface PluginConfig {
deprecations?: Deprecation[];
}
export declare function publish({ deprecations }: PluginConfig, context: Context): Promise<void>;
export declare const renderDeprecations: (deprecations: Deprecation[], context: Context) => {
version: string;
message: string;
}[];
export declare const getPackage: (context: Context) => Promise<any>;
export declare const deprecate: ({ version, message }: Deprecation, name: string, npmrc: string, registry: string, context: Context) => void;
export declare const setNpmrc: (npmrc: string, registry: string, context: Context) => Promise<void>;