Skip to content

Latest commit

 

History

History
230 lines (158 loc) · 8.87 KB

README.md

File metadata and controls

230 lines (158 loc) · 8.87 KB
Raw

jsii-release

This library includes a set of programs that can be used to release multiple modules into various package managers.

Usage

This is an npm module. You can install it using yarn add jsii-release or npm install jsii-release. In most cases it will be installed as a devDependency in your package.json.

This tool expects to find a distribution directory (default name is dist) which contains "ready-to-publish" artifacts for each package manager. This structure is compatible with jsii-pacmak:

  • dist/js/*.tgz - npm tarballs
  • dist/python/*.whl - Python wheels
  • dist/nuget/*.nupkg - Nuget packages
  • dist/java/** - Maven artifacts in local repository structure
  • dist/go/**/go.mod - Go modules. Each subdirectory should have its own go.mod file.

Each publisher needs a set of environment variables with credentials as described below (NPM_TOKEN, TWINE_PASSWORD etc).

Then:

$ jsii-release

You can customize the distribution directory through jsii-release DIR (the default is dist)

This command will discover all the artifacts based on the above structure and will publish them to their respective package manager.

You can also execute individual publishers:

  • jsii-release-maven
  • jsii-release-nuget
  • jsii-release-npm
  • jsii-release-pypi
  • jsii-release-golang

npm

Publishes all *.tgz files from DIR to npmjs, GitHub Packages or AWS CodeArtifact.

If AWS CodeArtifact is used as npm registry, a temporary npm authorization token is created using AWS CLI. Therefore, it is necessary to provide the necessary configuration settings, e.g. by passing access key ID and secret access key to this script.

Usage:

npx jsii-release-npm [DIR]

DIR is a directory with npm tarballs (*.tgz). Default is dist/js.

Options (environment variables):

Option Required Description
NPM_TOKEN Optional Registry authentication token (either npm.js publishing token or a GitHub personal access token), not used for AWS CodeArtifact
NPM_REGISTRY Optional The registry URL (defaults to "registry.npmjs.org"). Use "npm.pkg.github.com" to publish to GitHub Packages. Use repository endpoint for AWS CodeAtifact, e.g. "my-domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/npm/my_repo/".
NPM_DIST_TAG Optional Registers the published package with the given dist-tag (e.g. next, default is latest)
AWS_ACCESS_KEY_ID Optional If AWS CodeArtifact is used as registry, an AWS access key can be spedified.
AWS_SECRET_ACCESS_KEY Optional Secret access key that belongs to the AWS access key.

Maven

Publishes all Maven modules in the DIR to Maven Central.

Usage:

npx jsii-release-maven [DIR]

DIR is a directory with a local maven layout. Default is dist/java.

Options (environment variables):

Option Required Description
MAVEN_USERNAME and MAVEN_PASSWORD Yes Username and password for maven repository. For Maven Central, you will need to Create JIRA account and then request a new project. Read the OSSRH guide for more details.
MAVEN_GPG_PRIVATE_KEY or MAVEN_GPG_PRIVATE_KEY_FILE and MAVEN_GPG_PRIVATE_KEY_PASSPHRASE Yes for Maven Central GPG private key or file that includes it. This is used to sign your Maven packages. See instructions below
MAVEN_STAGING_PROFILE_ID Yes for Maven Central Maven Central (sonatype) staging profile ID (e.g. 68a05363083174). Staging profile ID can be found in the URL of the "Releases" staging profile under "Staging Profiles" in https://oss.sonatype.org if you are logged in (e.g. https://oss.sonatype.org/#stagingProfiles;68a05363083174).
MAVEN_ENDPOINT No URL of Nexus repository. Defaults to https://oss.sonatype.org
MAVEN_SERVER_ID No Used in maven settings for credential lookup (e.g. use github when publishing to GitHub). Defaults to ossrh for Maven Central.
MAVEN_REPOSITORY_URL No Deployment repository when not deploying to Maven Central
MAVEN_DRYRUN No Set to "true" for a dry run

How to create a GPG key?

Install GnuPG.

Generate your key:

$ gpg --full-generate-key
# select RSA only, 4096, passphrase

Your selected passphrase goes to MAVEN_GPG_PRIVATE_KEY_PASSPHRASE.

Export and publish the public key:

$ gpg -a --export > public.pem

Go to https://keyserver.ubuntu.com/ and submit the public key. You can use cat public.pem and copy/paste it into the "Submit Key" dialog.

Export the private key:

$ gpg -a --export-secret-keys <fingerprint> > private.pem

Now, either set MAVEN_GPG_PRIVATE_KEY_FILE to point to private.pem or export the private key to a single line where newlines are encoded as \n and then assign it to MAVEN_GPG_PRIVATE_KEY:

$ echo $(cat -e private.pem) | sed 's/\$ /\\n/g' | sed 's/\$$//'

Publish to GitHub Packages

An example GitHub Actions publish step:

- name: Publish package
  run: npx -p jsii-release jsii-release-maven
  env:
    MAVEN_SERVER_ID: github
    MAVEN_USERNAME: ${{ github.actor }}
    MAVEN_PASSWORD: ${{ secrets.GITHUB_TOKEN }}
    MAVEN_REPOSITORY_URL: "https://maven.pkg.github.com/${{ github.repository }}"

NuGet

Publishes all *.nupkg to the NuGet Gallery.

Usage:

npx jsii-release-nuget [DIR]

DIR is a directory with Nuget packages (*.nupkg). Default is dist/dotnet.

Options (environment variables):

Option Required Description
NUGET_API_KEY Required NuGet API Key with "Push" permissions
NUGET_SERVER Optional NuGet Server URL (defaults to nuget.org)

Publish to GitHub Packages

  • Set NUGET_SERVER to https://nuget.pkg.github.com/(org or user).
  • Set NUGET_API_KEY to a token with write packages permissions.
  • Make sure the repository url in the project file matches the org or user used for the server

PyPI

Publishes all *.whl files to PyPI.

Usage:

npx jsii-release-pypi [DIR]

DIR is a directory with Python wheels (*.whl). Default is dist/python.

Options (environment variables):

Option Required Description
TWINE_USERNAME Required PyPI username (register)
TWINE_PASSWORD Required PyPI password
TWINE_REPOSITORY_URL Optional The registry URL (defaults to Twine default)

Golang

Pushes a directory of golang modules to a GitHub repository.

Usage:

npx jsii-release-golang [DIR]

DIR is a directory where the golang modules are located (default is dist/go). Modules can be located either in subdirectories, (e.g 'dist/go/my-module/go.mod') or in the root (e.g 'dist/go/go.mod').

If you specify the VERSION env variable, all modules will recieve that version, otherwise a version file is expected to exist in each module directory. Repository tags will be in the following format:

  • For a module located at the root: v${module_version} (e.g v1.20.1)
  • For modules located inside subdirectories: <subdir-name>/v${module_version} (e.g my-module/v3.3.1)

Options (environment variables):

Option Required Description
GITHUB_TOKEN Required GitHub personal access token.
VERSION Optional Module version. Defaults to the value in the 'version' file of the module directory. Fails if it doesn't exist.
the module name.
GIT_BRANCH Optional Branch to push to. Defaults to 'main'.
GIT_USER_NAME Optional Username to perform the commit with. Defaults to the git user.name config in the current directory. Fails if it doesn't exist.
GIT_USER_EMAIL Optional Email to perform the commit with. Defaults to the git user.email config in the current directory. Fails if it doesn't exist.
GIT_COMMIT_MESSAGE Optional The commit message. Defaults to 'chore(release): $VERSION'.
DRYRUN Set to "true" for a dry run.

Roadmap

  • GitHub Support: Maven
  • GitHub Support: NuGet
  • CodeArtifact Support: Maven
  • CodeArtifact Support: NuGet
  • CodeArtifact Support: Python

License

Released under the Apache 2.0 license.