Merge branch 'master' into feature/greater-package-version

Author: philsturgeon

README.md

@@ -63,16 +63,17 @@ jobs:
 
 You can set any or all of the following input parameters:
 
-| Name                   | Type    | Required? | Default                                                             | Description                                                                                                             |
-| ---------------------- | ------- | --------- | ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
-| `token`                | string  | yes       |                                                                     | The NPM auth token to use for publishing                                                                                |
-| `registry`             | string  | no        | https://registry.npmjs.org/                                         | The NPM registry URL to use                                                                                             |
-| `package`              | string  | no        | ./package.json                                                      | The path of your package.json file                                                                                      |
-| `tag`                  | string  | no        | "latest"                                                            | The tag to publish to. This allows people to install the package using `npm install <package-name>@<tag>`.              |
-| `access`               | string  | no        | "public" for non-scoped packages. "restricted" for scoped packages. | Determines whether the published package should be publicly visible, or restricted to members of your NPM organization. |
-| `dry-run`              | boolean | no        | false                                                               | Run NPM publish with the `--dry-run` flag to prevent publication                                                        |
-| `check-version`        | boolean | no        | true                                                                | Only publish to NPM if the version number in `package.json` differs from the latest on NPM                              |
-| `greater-version-only` | boolean | no        | false                                                               | Only publish to NPM if the version number in `package.json` is greater than the latest on NPM                           |
+|Name                  |Type     |Default                     |Description
+|----------------------|-------- |----------------------------|------------------------------------
+|`token`               |string   |**required**                |The NPM auth token to use for publishing
+|`registry`            |string   |https://registry.npmjs.org/ |The NPM registry URL to use
+|`package`             |string   |./package.json              |The path of your package.json file
+|`tag`                 |string   |"latest"                    |The tag to publish to. This allows people to install the package using `npm install <package-name>@<tag>`.
+|`access`              |string   |"public" for non-scoped packages. "restricted" for scoped packages.|Determines whether the published package should be publicly visible, or restricted to members of your NPM organization.
+|`dry-run`             |boolean  |false                       |Run NPM publish with the `--dry-run` flag to prevent publication
+|`check-version`       |boolean  |true                        |Only publish to NPM if the version number in `package.json` differs from the latest on NPM
+|`greater-version-only`|boolean  |false                       |Only publish to NPM if the version number in `package.json` is greater than the latest on NPM                           |
+
 
 ## Output Variables
 

src/action/index.ts

@@ -32,22 +32,22 @@ async function main(): Promise<void> {
 
     if (results.type === "none") {
       console.log(
-        `\n📦 ${results.package} v${results.version} is already published to NPM`
+        `\n📦 ${results.package} v${results.version} is already published to ${options.registry}`
       );
     }
     if (results.type === "lower") {
       console.log(
-        `\n📦 ${results.package} v${results.version} is lower than the version published to NPM`
+        `\n📦 ${results.package} v${results.version} is lower than the version published to ${options.registry}`
       );
     }
     else if (results.dryRun) {
       console.log(
-        `\n📦 ${results.package} v${results.version} was NOT actually published to NPM (dry run)`
+        `\n📦 ${results.package} v${results.version} was NOT actually published to ${options.registry} (dry run)`
       );
     }
     else {
       console.log(
-        `\n📦 Successfully published ${results.package} v${results.version} to NPM`
+        `\n📦 Successfully published ${results.package} v${results.version} to ${options.registry}`
       );
     }
 

src/cli/index.ts

@@ -35,13 +35,13 @@ export async function main(args: string[]): Promise<void> {
 
       if (!options.quiet) {
         if (results.type === "none") {
-          console.log(`\n📦 ${results.package} v${results.version} is already published to NPM`);
+          console.log(`\n📦 ${results.package} v${results.version} is already published to ${options.registry}`);
         }
         else if (results.dryRun) {
-          console.log(`\n📦 ${results.package} v${results.version} was NOT actually published to NPM (dry run)`);
+          console.log(`\n📦 ${results.package} v${results.version} was NOT actually published to ${options.registry} (dry run)`);
         }
         else {
-          console.log(`\n📦 Successfully published ${results.package} v${results.version} to NPM`);
+          console.log(`\n📦 Successfully published ${results.package} v${results.version} to ${options.registry}`);
         }
       }
     }

src/npm.ts

@@ -109,7 +109,7 @@ export const npm = {
       await ezSpawn.async(command, { cwd, stdio, env });
     }
     catch (error) {
-      throw ono(error, `Unable to publish ${name} v${version} to NPM.`);
+      throw ono(error, `Unable to publish ${name} v${version} to ${options.registry}.`);
     }
   },
 };