@peiyanlu/release 2.0.0 → 2.1.0

package/dist/index.d.mts

@@ -5,7 +5,6 @@ import { FinalTemplateContext } from "@conventional-changelog/template";
 import { ReleaseType } from "semver";
 import { Octokit, Octokit as Octokit$1 } from "@octokit/rest";
 import { getOctokit } from "@actions/github";
-//#region src/core/changelog/changelog.types.d.ts
 export interface ChangelogOptions {
   pkgDir?: string;
   tagPrefix?: string;
@@ -21,8 +20,6 @@ export interface ChangelogOptions {
   version?: string;
   previousTag?: string;
 }
-//#endregion
-//#region src/core/changelog/changelog.d.ts
 interface LastRelease {
   version: string;
   notes: string;
@@ -47,16 +44,10 @@ export declare class Changelog {
   read(): Promise<string>;
   write(): Promise<string>;
 }
-//#endregion
-//#region src/core/changelog/committype.d.ts
 export declare const defaultTypes: CommitType[];
-//#endregion
-//#region src/core/changelog/templates.d.ts
 export declare function headerPartial(context: FinalTemplateContext): string;
 export declare function preamblePartial(contest: FinalTemplateContext): string;
 export declare function template(context: FinalTemplateContext): string;
-//#endregion
-//#region src/core/logger.d.ts
 export type Printer = (message: LoggerMessage) => void;
 export type Color = (text: string) => string;
 export interface LoggerOptions {
@@ -105,16 +96,12 @@ export declare class Logger {
   createChild(stage: string): ChildLogger;
   private getColor;
 }
-//#endregion
-//#region src/core/manifest/manifest.types.d.ts
 export interface ProjectManifestVersionUpdate {
   name: string;
   from: string;
   to: string;
   files: string[];
 }
-//#endregion
-//#region src/core/manifest/manifest.d.ts
 export declare abstract class ProjectManifest<T = Dict> {
   filepath: string;
   static Filename: string;
@@ -129,23 +116,20 @@ export declare abstract class ProjectManifest<T = Dict> {
   abstract writeVersion(versin: string, dryRun?: boolean): Promise<ProjectManifestVersionUpdate>;
   getPrereleaseVersion(): Promise<readonly (string | number)[] | null>;
 }
-//#endregion
-//#region src/core/utils.d.ts
 interface HostedGitInfo {
+  origin: string;
   host: string;
+  hostname: string;
+  port: string;
   prefix: string;
   owner: string;
   repo: string;
 }
-//#endregion
-//#region src/core/manifest/packageJson.types.d.ts
 export interface PackageJsonProps extends Dict<any> {
   name: string;
   version: string;
   private?: boolean;
 }
-//#endregion
-//#region src/core/manifest/packageJson.d.ts
 export declare class PackageJsonManifest<T extends PackageJsonProps = PackageJsonProps> extends ProjectManifest<T> {
   static override Filename: string;
   contents?: string;
@@ -157,8 +141,6 @@ export declare class PackageJsonManifest<T extends PackageJsonProps = PackageJso
   writeVersion(version: string, dryRun?: boolean): Promise<ProjectManifestVersionUpdate>;
   private contentsMutex?;
 }
-//#endregion
-//#region src/core/manifest/composed.d.ts
 export declare class ComposedProjectManifest<T = Dict> extends ProjectManifest<T> {
   mainManifest: ProjectManifest<T>;
   subManifests: ProjectManifest[];
@@ -171,8 +153,6 @@ export declare class ComposedProjectManifest<T = Dict> extends ProjectManifest<T
   isPrivate(): Promise<boolean>;
   writeVersion(version: string, dryRun?: boolean): Promise<ProjectManifestVersionUpdate>;
 }
-//#endregion
-//#region src/core/project/project.types.d.ts
 export type TagPrefixResolver = (scope: string) => string | Promise<string>;
 export interface ProjectOptions {
   changelogFile?: string;
@@ -216,16 +196,16 @@ export interface ProjectNextVersionOptions extends ProjectTagPrefixOptions {
    * 忽略项目为私有项目这一限制。
    */
   forcePrivate?: boolean;
-  /**
-   * 强制升级到指定版本。
-   * 未提供时，根据提交记录确定版本。
-   */
-  version?: string;
   /**
    * 用于计算升级版本的基准版本。
    * 未提供时，从清单文件中读取版本。
    */
   baseVersion?: string;
+  /**
+   * 强制升级到指定版本。
+   * 未提供时，根据提交记录确定版本。
+   */
+  version?: string;
   /**
    * 要升级到的发布类型。
    * 未提供时，根据提交记录确定版本。
@@ -266,11 +246,6 @@ export interface ProjectPublishOptions {
   /** 发布通道标签。由具体项目类型解释，例如 npm dist-tag 或 GitHub Action 分支别名。 */
   tag?: string | ((version: string, prerelease: readonly (string | number)[] | null) => string);
 }
-export interface ProjectPublishCheckOptions {
-  logger?: ChildLogger;
-}
-//#endregion
-//#region src/core/project/monorepo.types.d.ts
 export type MonorepoMode = "fixed" | "independent";
 export type GetProjectsOptions = Simplify<Required<Pick<ProjectOptions, "compose" | "manifest">>>;
 export interface MonorepoProjectOptions extends ProjectOptions {
@@ -301,7 +276,7 @@ export interface MonorepoProjectOptions extends ProjectOptions {
    */
   tagPrefix?(scope: string): string | Promise<string>;
 }
-type NextVersionKeys = "skip" | "version" | "as" | "prerelease" | "snapshot" | "firstRelease";
+type NextVersionKeys = "version" | "as" | "prerelease" | "snapshot" | "firstRelease";
 type BumpKeys = "skipChangelog" | "releaseCount" | "preamble" | "transformTypes";
 export type MonorepoProjectBumpByProjectOptions = Pick<ProjectBumpOptions, NextVersionKeys | BumpKeys>;
 export interface MonorepoProjectBumpOptions extends Omit<ProjectBumpOptions, "tagPrefix"> {
@@ -319,8 +294,6 @@ export interface MonorepoProjectBumpOptions extends Omit<ProjectBumpOptions, "ta
    */
   byProject?: Record<string, MonorepoProjectBumpByProjectOptions>;
 }
-//#endregion
-//#region src/core/project/monorepo.d.ts
 export declare abstract class MonorepoProject extends Project {
   readonly mode: MonorepoMode;
   options: MonorepoProjectOptions & ProjectOptions;
@@ -354,8 +327,6 @@ export declare abstract class MonorepoProject extends Project {
   private fixedBump;
   private isIndependentFirstRelease;
 }
-//#endregion
-//#region src/core/project/project.d.ts
 export declare const DEFAULT_TAG_PREFIX = "v";
 export declare const DEFAULT_CHANGELOG_FILE = "CHANGELOG.md";
 export declare const DEFAULT_PUBLISH_TAG = "latest";
@@ -389,10 +360,7 @@ export declare abstract class Project {
   bump(options?: ProjectBumpOptions): Promise<boolean>;
   revert(options?: ProjectRevertOptions, filesSet?: Set<string>): Promise<boolean>;
   abstract publish(options?: ProjectPublishOptions): Promise<void>;
-  abstract publishCheck(options?: ProjectPublishCheckOptions): Promise<void>;
 }
-//#endregion
-//#region src/core/hosting/hosting.types.d.ts
 export interface ReleaseData {
   version: string;
   title: string;
@@ -414,37 +382,23 @@ export interface CreatePullRequestOptions {
   dryRun?: boolean;
   logger?: ChildLogger;
 }
-export interface ReleaseCheckOptions {
-  logger?: ChildLogger;
-}
-//#endregion
-//#region src/core/hosting/hosting.d.ts
 /** Git 仓库托管服务的基类 */
 export declare abstract class GitRepositoryHosting {
   /** 为提供的项目创建 release */
   abstract createRelease(options: CreateReleaseOptions): Promise<void>;
   /** 未提供的项目创建 pull request */
   abstract createPullRequest(options: CreatePullRequestOptions): Promise<void>;
-  /** 检查创建 release 需要的条件 */
-  abstract releaseCheck(options?: ReleaseCheckOptions): Promise<void>;
 }
-//#endregion
-//#region src/core/project/packageJson.types.d.ts
 export interface PackageJsonProjectOptions extends Omit<ProjectOptions, "manifest"> {
   /**
    * package.json 文件的路径。
    */
   path?: string;
 }
-//#endregion
-//#region src/core/project/packageJson.d.ts
 export declare class PackageJsonProject extends Project {
   constructor(options?: Simplify<PackageJsonProjectOptions>);
   override publish(_options?: ProjectPublishOptions): Promise<void>;
-  override publishCheck(_options?: ProjectPublishCheckOptions): Promise<void>;
 }
-//#endregion
-//#region src/core/project/packageJsonMonorepo.types.d.ts
 export interface PackageJsonMonorepoProjectOptions extends Omit<MonorepoProjectOptions, "getProjects" | "manifest"> {
   mode: MonorepoMode;
   /**
@@ -456,18 +410,13 @@ export interface PackageJsonMonorepoProjectOptions extends Omit<MonorepoProjectO
    */
   getProjects(options: GetProjectsOptions): AsyncIterable<string>;
 }
-//#endregion
-//#region src/core/project/packageJsonMonorepo.d.ts
 /**
  * 基于 package.json 的单体仓库项目。
  */
 export declare class PackageJsonMonorepoProject extends MonorepoProject {
   constructor(options: Simplify<PackageJsonMonorepoProjectOptions>);
   override publish(_options?: ProjectPublishOptions): Promise<void>;
-  override publishCheck(_options?: ProjectPublishCheckOptions): Promise<void>;
 }
-//#endregion
-//#region src/core/releaser.type.d.ts
 export type PickOverridableOptions<T extends AnyFunction> = Partial<Omit<Exclude<Parameters<T>[0], undefined>, "dryRun" | "logger" | "tagPrefix" | "project">>;
 export interface ReleaserOptions<P extends Project = Project, G extends GitRepositoryHosting = GitRepositoryHosting> {
   /**
@@ -537,8 +486,6 @@ export interface ReleaserStepsOptions<P extends Project = Project, G extends Git
 }
 export type ReleaserStep = keyof ReleaserStepsOptions;
 export type ReleaserSkipOptions = Partial<Record<ReleaserStep, boolean>>;
-//#endregion
-//#region src/core/releaser.d.ts
 export declare class Releaser<P extends Project = Project, G extends GitRepositoryHosting = GitRepositoryHosting> {
   options: ReleaserOptions<P, G>;
   readonly project: P;
@@ -572,8 +519,6 @@ export declare class Releaser<P extends Project = Project, G extends GitReposito
   protected shouldSkip(step: ReleaserStep): boolean;
   private getBaseBranch;
 }
-//#endregion
-//#region src/config/index.d.ts
 export interface UserConfig<P extends Project = Project, G extends GitRepositoryHosting = GitRepositoryHosting> extends ReleaserStepsOptions<P, G> {
   project?: P;
   hosting?: G;
@@ -586,8 +531,6 @@ export declare const loadConfig: <T extends object>(cwd?: string) => Promise<{
   file: string;
   config: T;
 }>;
-//#endregion
-//#region src/hosting-github/github.type.d.ts
 export interface GithubOptions {
   /**
    * 用于通过 GitHub API 进行身份验证的 GitHub Personal Access Token。
@@ -632,8 +575,6 @@ export interface ListPullRequestOptions {
   repo: string;
   from: string;
 }
-//#endregion
-//#region src/hosting-github/github.d.ts
 export declare class GithubHosting extends GitRepositoryHosting {
   private readonly options;
   readonly octokit: Octokit;
@@ -641,7 +582,6 @@ export declare class GithubHosting extends GitRepositoryHosting {
   constructor(options?: GithubOptions);
   createRelease(options: CreateReleaseOptions): Promise<void>;
   createPullRequest(options: GithubCreatePullRequestOptions): Promise<void>;
-  releaseCheck(options?: ReleaseCheckOptions): Promise<void>;
   getRepositoryId(project: Project): Promise<RepositoryId>;
   private uploadAssets;
   private getRelease;
@@ -649,8 +589,6 @@ export declare class GithubHosting extends GitRepositoryHosting {
   private getDefaultBranch;
   private getPullRequestData;
 }
-//#endregion
-//#region src/project-github-action/publish.d.ts
 export interface PublishOptions extends ProjectPublishOptions {
   /**
    * 发布引用前要运行的构建或安装命令。
@@ -667,8 +605,6 @@ export interface PublishOptions extends ProjectPublishOptions {
   env?: Record<string, string | undefined>;
 }
 export declare const publish: (project: NodeGithubActionProject, options?: PublishOptions) => Promise<void>;
-//#endregion
-//#region src/project-github-action/project.d.ts
 export interface NodeGithubActionProjectOptions extends PackageJsonProjectOptions {
   /**
    * 版本标签的前缀。
@@ -687,12 +623,9 @@ export declare class NodeGithubActionProject extends PackageJsonProject {
    */
   override getLastReleaseTag(options?: ProjectReleaseOptions): Promise<string | undefined>;
   override publish(options?: NodeGithubActionProjectPublishOptions): Promise<void>;
-  override publishCheck(options: ProjectPublishCheckOptions): Promise<void>;
   constructor(options?: NodeGithubActionProjectOptions);
   private isReachableFromHead;
 }
-//#endregion
-//#region src/project-npm/publish.d.ts
 interface CleanupOptions$1 {
   /** 是否清理项目内容后再发布 */
   cleanPublish?: boolean;
@@ -709,18 +642,13 @@ interface PublishOptions$2 extends ProjectPublishOptions, CleanupOptions$1 {
   otp?: string;
   env?: Record<string, string | undefined>;
 }
-//#endregion
-//#region src/project-npm/project.d.ts
 export type NpmProjectOptions = PackageJsonProjectOptions;
 export type NpmProjectBumpOptions = ProjectBumpOptions;
 export type NpmProjectPublishOptions = PublishOptions$2;
 /** 一个基于 npm 的项目，使用 package.json 进行配置 */
 export declare class NpmProject extends PackageJsonProject {
   override publish(options?: NpmProjectPublishOptions): Promise<void>;
-  override publishCheck(options?: ProjectPublishCheckOptions): Promise<void>;
 }
-//#endregion
-//#region src/project-npm/workspacesProject.d.ts
 export type NpmWorkspacesProjectOptions = Omit<PackageJsonMonorepoProjectOptions, "getProjects">;
 export type NpmWorkspacesProjectBumpOptions = ProjectBumpOptions;
 export type NpmWorkspacesProjectPublishOptions = PublishOptions$2;
@@ -729,10 +657,7 @@ export declare class NpmWorkspacesProject extends PackageJsonMonorepoProject {
   static GlobIgnore: string[];
   constructor(options: NpmWorkspacesProjectOptions);
   override publish(options?: NpmWorkspacesProjectPublishOptions): Promise<void>;
-  override publishCheck(options?: ProjectPublishCheckOptions): Promise<void>;
 }
-//#endregion
-//#region src/project-pnpm/publish.d.ts
 interface CleanupOptions {
   /** 是否清理项目内容后再发布 */
   cleanPublish?: boolean;
@@ -751,18 +676,13 @@ interface PublishOptions$1 extends ProjectPublishOptions, CleanupOptions {
   /** 是否在发布前执行 git 检查 */
   gitChecks?: boolean;
 }
-//#endregion
-//#region src/project-pnpm/project.d.ts
 export type PnpmProjectOptions = PackageJsonProjectOptions;
 export type PnpmProjectBumpOptions = ProjectBumpOptions;
 export type PnpmProjectPublishOptions = PublishOptions$1;
 /** 一个基于 pnpm 的项目，使用 package.json 进行配置 */
 export declare class PnpmProject extends PackageJsonProject {
   override publish(options?: PnpmProjectPublishOptions): Promise<void>;
-  override publishCheck(options?: ProjectPublishCheckOptions): Promise<void>;
 }
-//#endregion
-//#region src/project-pnpm/workspacesProject.d.ts
 export type PnpmWorkspacesProjectOptions = Omit<PackageJsonMonorepoProjectOptions, "getProjects">;
 export type PnpmWorkspacesProjectBumpOptions = ProjectBumpOptions;
 export type PnpmWorkspacesProjectPublishOptions = PublishOptions$1;
@@ -772,10 +692,7 @@ export declare class PnpmWorkspacesProject extends PackageJsonMonorepoProject {
   static GlobIgnore: string[];
   constructor(options: PnpmWorkspacesProjectOptions);
   override publish(options?: PnpmWorkspacesProjectPublishOptions): Promise<void>;
-  override publishCheck(options?: ProjectPublishCheckOptions): Promise<void>;
 }
-//#endregion
-//#region src/releaser-github-action/releaser.d.ts
 export interface ReleaserGithubActionOptions<P extends Project = Project> extends Omit<ReleaserOptions<P, GithubHosting>, "hosting"> {
   /** 用于进行 GitHub API 调用的 Octokit 实例 */
   octokit: ReturnType<typeof getOctokit>;
@@ -794,8 +711,6 @@ export declare class ReleaserGithubAction<P extends Project = Project> extends R
   runSnapshotAction(snapshotTag: string): Promise<void>;
   runAction(): Promise<void>;
 }
-//#endregion
-//#region src/releaser-github-action/conditions.d.ts
 export declare const ifReleaseCommit: (releaser: ReleaserGithubAction) => Promise<boolean>;
 /**
  * 检测当前事件是否为针对处于打开状态的发布拉取请求的受支持命令评论：
@@ -804,8 +719,6 @@ export declare const ifReleaseCommit: (releaser: ReleaserGithubAction) => Promis
  * @returns 如果是此类评论，则返回 `目标分支`；如果是评论事件但不是命令评论，则返回 `false`；如果根本不是评论事件，则返回 `null`
  */
 export declare const ifCommandComment: () => string | false | null;
-//#endregion
-//#region src/releaser-github-action/options.d.ts
 interface InputOptions<T> {
   checkout: Partial<{
     branch: string;
@@ -816,7 +729,6 @@ interface InputOptions<T> {
     prerelease: string;
     snapshot: string;
     firstRelease: boolean;
-    skip: boolean;
     /** monorepo bump */
     byProject: T;
   }>;
@@ -824,7 +736,6 @@ interface InputOptions<T> {
     enabled: boolean;
   }>;
   publish: Partial<{
-    skip: boolean;
     /** npm publish */
     access: string;
     tag: string;
@@ -832,11 +743,10 @@ interface InputOptions<T> {
 }
 export declare const getInputOptions: <T extends Dict>() => InputOptions<T>;
 export declare const getInputSkippedSteps: () => ReleaserSkipOptions;
-//#endregion
-//#region src/releaser-cli/releaser.d.ts
 export interface ReleaserCliRunOptions {
   dryRun?: boolean;
   ci?: boolean;
+  skipBump?: boolean;
   skipGit?: boolean;
   skipPublish?: boolean;
   skipRelease?: boolean;
@@ -857,10 +767,8 @@ export declare class ReleaserCli<P extends Project = Project, G extends GitRepos
   override run(...args: []): Promise<void>;
   setCliOptions(options: ReleaserCliRunOptions): this;
   setLegacyOptions(): this;
-  check(): this;
   start(): this;
   end(): void;
   runAction(options: ReleaserCliRunOptions): Promise<void>;
 }
-//#endregion
 export { Octokit };