Function generateChangelog

  • generateChangelog(
        params: {
            cwd?: string | URL;
            params?: VersioningOptions;
            since: string;
            workspace: WorkspacePackage[];
        },
    ): Promise<string>

  • simple changelog generator based on git commits history

    Parameters

    • params: {
          cwd?: string | URL;
          params?: VersioningOptions;
          since: string;
          workspace: WorkspacePackage[];
      }
      • Optionalcwd?: string | URL

        root of the git repo

      • Optionalparams?: VersioningOptions

        versioning params

      • since: string

        starting point for the changelog (defaults to latest tag)

      • workspace: WorkspacePackage[]

        packages for which to generate the changelog

    Returns Promise<string>

Settings

Member Visibility