npm-update-package 0.22.2 → 0.22.3

package/README.md

@@ -57,8 +57,8 @@ Package manager of your project
 - type: string
 - required: false
 - allowed values:
-  - `npm`
-  - `yarn`
+  - `npm`: npm
+  - `yarn`: Yarn
 - default: `npm`
 
 ### `--pull-request-title`
@@ -76,15 +76,22 @@ Pull request title template
 
 ## GitHub token
 
-To run npm-update-package, GitHub token is required.  
+GitHub token is required to run npm-update-package.  
 For example, the following tokens can be used.
 
-|GitHub token|Pull request author|Trigger other action|
+|GitHub token|Author of pull requests|Trigger other actions|
 |---|---|---|
 |[GitHub Actions](https://docs.github.com/en/actions/security-guides/automatic-token-authentication)|`github-actions`||
 |[GitHub App](https://docs.github.com/en/developers/apps/building-github-apps/authenticating-with-github-apps)|GitHub App which issued the token|✓|
 |[Personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)|user who issued the token|✓|
 
+We recommend using GitHub App for the following reasons.
+
+- When you use the token of GitHub Actions, the job will not trigger other actions.
+- When you use the Personal access token, the author of pull requests will be the user who issued the token.
+
+Creating a GitHub App may be tedious, but you only have to do it once the first time.
+
 ### Token of GitHub App
 
 These permissions are required.
@@ -160,12 +167,12 @@ Actual working examples can be seen in these repositories.
 
 |Repository|Package manager|GitHub token|
 |---|---|---|
-|[example-npm](https://github.com/npm-update-package/example-npm)|npm|GitHub Actions|
+|[example-github-actions](https://github.com/npm-update-package/example-github-actions)|npm|GitHub Actions|
 |[example-github-app](https://github.com/npm-update-package/example-github-app)|npm|GitHub App|
 
 ## Flow
 
-The following shows the process flow of npm-update-package:
+The following shows the process flow of npm-update-package.
 
 <!--
 ```plantuml
@@ -212,6 +219,6 @@ end
 
 npm-update-package can be used in environments where Renovate cannot be used for some reason.
 
-### Conflicts have occurred in pull request. What should I do?
+### Conflicts have occurred in the pull request. What should I do?
 
-If conflicts have occurred in pull request, close it and run npm-update-package again.
+If conflicts have occurred in the pull request, close it and run npm-update-package again.

package/dist/app.js

@@ -3,6 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.app = void 0;
 exports.app = {
     name: 'npm-update-package',
-    version: '0.22.2',
+    version: '0.22.3',
     web: 'https://github.com/npm-update-package/npm-update-package'
 };

package/dist/main.js

@@ -90,10 +90,10 @@ const main = async ({ options, logger }) => {
     logger.debug(`results=${JSON.stringify(results)}`);
     const succeededResults = results.filter(Either_1.isRight).map(({ right }) => right);
     logger.debug(`succeededResults=${JSON.stringify(succeededResults)}`);
-    const updatedPackages = succeededResults
-        .filter(({ updated }) => updated)
+    const createdPackages = succeededResults
+        .filter(({ created }) => created)
         .map(({ outdatedPackage }) => outdatedPackage);
-    logger.debug(`updatedPackages=${JSON.stringify(updatedPackages)}`);
+    logger.debug(`createdPackages=${JSON.stringify(createdPackages)}`);
     const skippedPackages = succeededResults
         .filter(({ skipped }) => skipped)
         .map(({ outdatedPackage }) => outdatedPackage);
@@ -104,8 +104,8 @@ const main = async ({ options, logger }) => {
     logger.debug(`failedPackages=${JSON.stringify(failedPackages)}`);
     // TODO: show as table
     logger.info(`Processed ${succeededResults.length + failedPackages.length} packages:
-- ${updatedPackages.length} packages has updated: ${updatedPackages.map(({ name }) => name).join(',')}
-- ${skippedPackages.length} packages has skipped: ${skippedPackages.map(({ name }) => name).join(',')}
-- ${failedPackages.length} packages has failed: ${failedPackages.map(({ name }) => name).join(',')}`);
+- ${createdPackages.length} packages: created (${createdPackages.map(({ name }) => name).join(',')})
+- ${skippedPackages.length} packages: skipped: (${skippedPackages.map(({ name }) => name).join(',')})
+- ${failedPackages.length} packages: failed: (${failedPackages.map(({ name }) => name).join(',')})`);
 };
 exports.main = main;

package/dist/processors/OutdatedPackageProcessor.js

@@ -65,7 +65,7 @@ class OutdatedPackageProcessor {
             }));
             return (0, Either_1.right)({
                 outdatedPackage,
-                updated: true
+                created: true
             });
         }
         finally {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "0.22.2",
+  "version": "0.22.3",
   "description": "CLI tool for creating pull requests to update npm packages",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",