You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-10Lines changed: 6 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,6 @@
2
2
3
3
This library includes a set of programs that can be used to release multiple modules into various package managers.
4
4
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
-
10
5
## Usage
11
6
12
7
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]
82
77
83
78
|Option|Required|Description|
84
79
|------|--------|-----------|
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.|
86
81
|`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.orgif you are logged in (e.g. `https://oss.sonatype.org/#stagingProfiles;68a05363083174`).|
88
83
|`MAVEN_ENDPOINT`|No|URL of Nexus repository. Defaults to `https://oss.sonatype.org`|
89
84
|`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.|
90
85
|`MAVEN_REPOSITORY_URL`|No|Deployment repository when not deploying to Maven Central|
@@ -108,9 +103,10 @@ Export and publish the public key:
108
103
$ gpg -a --export > public.pem
109
104
```
110
105
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.
112
108
113
-
Export and the private key:
109
+
Export the private key:
114
110
115
111
```console
116
112
$ gpg -a --export-secret-keys <fingerprint>> private.pem
@@ -158,7 +154,7 @@ npx jsii-release-nuget [DIR]
158
154
159
155
**Publish to GitHub Packages**
160
156
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`)`.
162
158
* Set `NUGET_API_KEY` to a token with write packages permissions.
163
159
* Make sure the repository url in the project file matches the org or user used for the server
0 commit comments