Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,6 @@

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

These scripts where extracted from
[aws-delivlib](https://github.com/awslabs/aws-delivlib), which is used to
release [jsii](https://github.com/aws/jsii) and the [AWS
CDK](https://github.com/aws/aws-cdk).

## Usage

This is an npm module. You can install it using `yarn add jsii-release` or `npm
Expand Down Expand Up @@ -82,9 +77,9 @@ npx jsii-release-maven [DIR]

|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](https://issues.sonatype.org/secure/Signup!default.jspa) and then request a [new project](https://issues.sonatype.org/secure/CreateIssue.jspa?issuetype=21&pid=10134)|
|`MAVEN_USERNAME` and `MAVEN_PASSWORD`|Yes|Username and password for maven repository. For Maven Central, you will need to [Create JIRA account](https://issues.sonatype.org/secure/Signup!default.jspa) and then request a [new project](https://issues.sonatype.org/secure/CreateIssue.jspa?issuetype=21&pid=10134). Read the [OSSRH guide](https://central.sonatype.org/pages/ossrh-guide.html) 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 (e.g. `https://oss.sonatype.org/#stagingProfiles;11a33451234521`|
|`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|
Expand All @@ -108,9 +103,10 @@ Export and publish the public key:
$ gpg -a --export > public.pem
```

Go to https://keyserver.ubuntu.com/ and submit the public key
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 and the private key:
Export the private key:

```console
$ gpg -a --export-secret-keys <fingerprint> > private.pem
Expand Down Expand Up @@ -158,7 +154,7 @@ npx jsii-release-nuget [DIR]

**Publish to GitHub Packages**

* Set `NUGET_SERVER` to `https://nuget.pkg.github.com/(`org or user`).
* 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

Expand Down