Interface VerifyConditionsContext

index.d.ts:54–90

   * Context used for the verify conditions step.
   */
  export interface VerifyConditionsContext extends BaseContext {
    /**
     * The current working directory to use. It should be configured to
     * the root of the Git repository to release from.
     *
     * It allows to run semantic-release from a specific path without
     * having to change the local process cwd with process.chdir().
     *
     * @default process.cwd
     */
    cwd?: string | undefined;

    /**
     * The environment variables to use.
     *
     * It allows to run semantic-release with specific environment
     * variables without having to modify the local process.env.
     *
     * @default process.env
     */
    env: Record<string, string>;

    /**
     * Information about the CI environment.
     */
    envCi: EnvCi;

    /**
     * Information of the current branch
     */
    branch: BranchObject;

    /**
     * Information on branches
     */
    branches: ReadonlyArray<BranchObject>;
  }

  /**
   * Context used for the analyze commits step.