jsii-release

  • Version 0.2.846
  • Published
  • 315 kB
  • 9 dependencies
  • Apache-2.0 license

Install

npm i jsii-release
yarn add jsii-release
pnpm add jsii-release

Overview

Release jsii modules to multiple package managers

Index

Classes

class GoReleaser

class GoReleaser {}
  • Release a set of Golang modules.

constructor

constructor(props: GoReleaserProps);

    method release

    release: () => GoRelease;
    • Run the release process.

      Returns

      metadata about the release.

    Interfaces

    interface GoModule

    interface GoModule {}
    • Information about a specific module.

    property cannonicalName

    readonly cannonicalName: string;
    • The cannonical name of the module. (e.g 'github.com/aws/constructs-go/constructs/v3`)

    property modFile

    readonly modFile: string;
    • Path to the mod file.

    property repoPath

    readonly repoPath: string;
    • The path inside the repository the module is located in. (e.g 'constructs')

    property repoURL

    readonly repoURL: string;
    • The repository URL. (e.g 'github.com/aws/constructs')

    property version

    readonly version: string;
    • The version of the module.

    interface GoRelease

    interface GoRelease {}
    • Encapsulates some information about the release.

    property commitMessage

    readonly commitMessage?: string;
    • The commit message of the release.

    property repoDir

    readonly repoDir?: string;
    • The directory where the repository was released from.

    property tags

    readonly tags?: string[];
    • The tags the release created.

    interface GoReleaserProps

    interface GoReleaserProps {}
    • Properties for GoReleaser.

    property branch

    readonly branch?: string;
    • The branch to push to.

      'main'

    property dir

    readonly dir?: string;
    • The source code directory.

      'dist/go'

    property dryRun

    readonly dryRun?: boolean;
    • Execute a dry run only.

      false

    property email

    readonly email?: string;
    • The email to use for the commit.

      - taken from git config. throws if not configured.

    property message

    readonly message?: string;
    • The message to use for the commit marking the release.

    property username

    readonly username?: string;
    • The username to use for the commit.

      - taken from git config. throws if not configured.

    property version

    readonly version?: string;
    • The version.

      - taken from the 'version'. throws if doesn't exist.

    Package Files (2)

    Dependencies (9)

    Dev Dependencies (19)

    Peer Dependencies (0)

    No peer dependencies.

    Badge

    To add a badge like this onejsDocs.io badgeto 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/jsii-release.

    • Markdown
      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/jsii-release)
    • HTML
      <a href="https://www.jsdocs.io/package/jsii-release"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>