publib - npm Package Compare versions

Comparing version 0.2.257 to 0.2.258

package.json

@@ -6,11 +6,18 @@ {
     "type": "git",
-    "url": "https://github.com/aws/jsii-release.git"
+    "url": "https://github.com/aws/publib.git"
   },
   "bin": {
-    "jsii-release": "bin/jsii-release",
-    "jsii-release-golang": "bin/jsii-release-golang",
-    "jsii-release-maven": "bin/jsii-release-maven",
-    "jsii-release-npm": "bin/jsii-release-npm",
-    "jsii-release-nuget": "bin/jsii-release-nuget",
-    "jsii-release-pypi": "bin/jsii-release-pypi"
+    "jsii-release": "./bin/jsii-release-shim",
+    "jsii-release-golang": "./bin/jsii-release-shim",
+    "jsii-release-maven": "./bin/jsii-release-shim",
+    "jsii-release-npm": "./bin/jsii-release-shim",
+    "jsii-release-nuget": "./bin/jsii-release-shim",
+    "jsii-release-pypi": "./bin/jsii-release-shim",
+    "jsii-release-shim": "bin/jsii-release-shim",
+    "publib": "bin/publib",
+    "publib-golang": "bin/publib-golang",
+    "publib-maven": "bin/publib-maven",
+    "publib-npm": "bin/publib-npm",
+    "publib-nuget": "bin/publib-nuget",
+    "publib-pypi": "bin/publib-pypi"
   },
@@ -26,3 +33,3 @@ "scripts": {
     "package": "npx projen package",
-    "package-as-publib": "npx projen package-as-publib",
+    "package-legacy": "npx projen package-legacy",
     "post-compile": "npx projen post-compile",
@@ -37,2 +44,3 @@ "post-upgrade": "npx projen post-upgrade",
     "upgrade": "npx projen upgrade",
+    "upgrade-projen": "npx projen upgrade-projen",
     "watch": "npx projen watch",
@@ -69,9 +77,6 @@ "projen": "npx projen"
   },
-  "keywords": [
-    "jsii"
-  ],
   "main": "lib/index.js",
   "license": "Apache-2.0",
-  "homepage": "https://github.com/aws/jsii-release",
-  "version": "0.2.257",
+  "homepage": "https://github.com/aws/publib",
+  "version": "0.2.258",
   "jest": {
@@ -78,0 +83,0 @@ "testMatch": [

README.md

@@ -1,20 +0,29 @@
-# jsii-release
+# publib
 
-This library includes a set of programs that can be used to release multiple modules into various package managers.
+> Previously known as `jsii-release`
 
+A unified toolchain for publishing libraries to popular package managers.
+
+Supports:
+
+* npm
+* PyPI
+* NuGet
+* Maven
+* Go (GitHub)
+
 ## 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`
+This is an npm module. You can install it using `yarn add publib` or
+`npm install publib`. 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`:
+which contains "ready-to-publish" artifacts for each package manager.
 
-- `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.
+* `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.
 
@@ -27,6 +36,6 @@ Each publisher needs a set of environment variables with credentials as
 ```shell
-$ jsii-release
+publib
 ```
 
-You can customize the distribution directory through `jsii-release DIR` (the
+You can customize the distribution directory through `publib DIR` (the
 default is `dist`)
@@ -39,7 +48,7 @@
 
-* `jsii-release-maven`
-* `jsii-release-nuget`
-* `jsii-release-npm`
-* `jsii-release-pypi`
-* `jsii-release-golang`
+* `publib-maven`
+* `publib-nuget`
+* `publib-npm`
+* `publib-pypi`
+* `publib-golang`
 
@@ -55,3 +64,3 @@ ## npm
 ```shell
-npx jsii-release-npm [DIR]
+npx publib-npm [DIR]
 ```
@@ -81,3 +90,3 @@
 ```shell
-npx jsii-release-maven [DIR]
+npx publib-maven [DIR]
 ```
@@ -93,3 +102,3 @@
 |`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 or https://s01.oss.sonatype.org if you are logged in (e.g. `https://oss.sonatype.org/#stagingProfiles;68a05363083174`).|
+|`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> or <https://s01.oss.sonatype.org> if you are logged in (e.g. `https://oss.sonatype.org/#stagingProfiles;68a05363083174`).|
 |`MAVEN_ENDPOINT`|Yes for new Maven Central users|URL of Nexus repository. Defaults to `https://oss.sonatype.org`. Use `https://s01.oss.sonatype.org` if you are a new user.|
@@ -116,6 +125,6 @@ |`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.|
 ```console
-$ gpg -a --export > public.pem
+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.
@@ -126,3 +135,3 @@
 ```console
-$ gpg -a --export-secret-keys <fingerprint> > private.pem
+gpg -a --export-secret-keys <fingerprint> > private.pem
 ```
@@ -135,3 +144,3 @@
 ```console
-$ echo $(cat -e private.pem) | sed 's/\$ /\\n/g' | sed 's/\$$//'
+echo $(cat -e private.pem) | sed 's/\$ /\\n/g' | sed 's/\$$//'
 ```
@@ -142,5 +151,6 @@
 An example GitHub Actions publish step:
+
 ```yaml
 - name: Publish package
-  run: npx -p jsii-release jsii-release-maven
+  run: npx -p publib publib-maven
   env:
@@ -160,3 +170,3 @@ MAVEN_SERVER_ID: github
 ```shell
-npx jsii-release-nuget [DIR]
+npx publib-nuget [DIR]
 ```
@@ -186,3 +196,3 @@
 ```shell
-npx jsii-release-pypi [DIR]
+npx publib-pypi [DIR]
 ```
@@ -200,3 +210,2 @@
 
-
 ## Golang
@@ -209,3 +218,3 @@
 ```shell
-npx jsii-release-golang [DIR]
+npx publib-golang [DIR]
 ```
@@ -218,5 +227,5 @@
 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`)
 
+* 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`)
 
@@ -236,10 +245,9 @@ **Options (environment variables):**
 
-
 ## Roadmap
 
-- [X] GitHub Support: Maven
-- [X] GitHub Support: NuGet
-- [ ] CodeArtifact Support: Maven
-- [ ] CodeArtifact Support: NuGet
-- [ ] CodeArtifact Support: Python
+* [X] GitHub Support: Maven
+* [X] GitHub Support: NuGet
+* [ ] CodeArtifact Support: Maven
+* [ ] CodeArtifact Support: NuGet
+* [ ] CodeArtifact Support: Python
 
@@ -246,0 +254,0 @@ ## License

New alerts

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

242

increased by3.42%

Worsened metrics

Total package byte prevSize

114903

decreased by-2.08%

Number of low quality alerts

2

increased by100%

No dependency changes