From 21a060320dcc3b29b4f25f0c7ea74d5abb373e1b Mon Sep 17 00:00:00 2001 From: Sebastian Hesse Date: Sun, 31 Jan 2021 16:51:54 +0100 Subject: [PATCH 1/2] Fix typos and provide additional hints --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index eae066d8..41753943 100644 --- a/README.md +++ b/README.md @@ -80,9 +80,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| @@ -106,9 +106,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 > private.pem @@ -156,7 +157,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 From 247383cf14afc4f7330ea2eb855dadae55f10b2c Mon Sep 17 00:00:00 2001 From: Elad Ben-Israel Date: Sun, 4 Jul 2021 10:16:25 +0300 Subject: [PATCH 2/2] Update README.md --- README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/README.md b/README.md index 41753943..30f3bf35 100644 --- a/README.md +++ b/README.md @@ -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