Skip to content

Commit a6800e3

Browse files
authored
Fix typos and provide additional hints (#24)
Hi, this is just a small PR to fix some typos and provide additional hints in the README.
1 parent e2cda7e commit a6800e3

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,6 @@
22

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

5-
These scripts where extracted from
6-
[aws-delivlib](https://github.com/awslabs/aws-delivlib), which is used to
7-
release [jsii](https://github.com/aws/jsii) and the [AWS
8-
CDK](https://github.com/aws/aws-cdk).
9-
105
## Usage
116

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

8378
|Option|Required|Description|
8479
|------|--------|-----------|
85-
|`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)|
80+
|`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.|
8681
|`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|
87-
|`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`|
82+
|`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`).|
8883
|`MAVEN_ENDPOINT`|No|URL of Nexus repository. Defaults to `https://oss.sonatype.org`|
8984
|`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.|
9085
|`MAVEN_REPOSITORY_URL`|No|Deployment repository when not deploying to Maven Central|
@@ -108,9 +103,10 @@ Export and publish the public key:
108103
$ gpg -a --export > public.pem
109104
```
110105

111-
Go to https://keyserver.ubuntu.com/ and submit the public key
106+
Go to https://keyserver.ubuntu.com/ and submit the public key.
107+
You can use `cat public.pem` and copy/paste it into the "Submit Key" dialog.
112108

113-
Export and the private key:
109+
Export the private key:
114110

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

159155
**Publish to GitHub Packages**
160156

161-
* Set `NUGET_SERVER` to `https://nuget.pkg.github.com/(`org or user`).
157+
* Set `NUGET_SERVER` to `https://nuget.pkg.github.com/(`org or user`)`.
162158
* Set `NUGET_API_KEY` to a token with write packages permissions.
163159
* Make sure the repository url in the project file matches the org or user used for the server
164160

0 commit comments

Comments
 (0)