npm-update-package 0.24.0 → 0.25.0

package/README.md

@@ -14,7 +14,7 @@ npx npm-update-package --github-token $GITHUB_TOKEN
 ## Options
 
 You can customize behavior via command-line options.  
-Template strings such as `--commit-message` can embed variables like `{{packageName}}`(HTML-escaped) or `{{{packageName}}}`(not HTML-escaped).
+Some options can embed variables like `{{packageName}}`(HTML-escaped) or `{{{packageName}}}`(not HTML-escaped).
 
 ### `--commit-message`
 
@@ -31,7 +31,7 @@ Commit message template
 
 ### `--github-token`
 
-[GitHub token](#github-token).
+[GitHub token](#github-token)
 
 - type: string
 - required: true
@@ -57,9 +57,16 @@ Package manager of your project
 - required: false
 - allowed values
   - `npm`: npm
-  - `yarn`: Yarn (**It has not been tested yet.**)
+  - `yarn`: Yarn
 - default: `npm`
 
+### `--pull-request-reviewers`
+
+Reviewers of pull request
+
+- type: string[]
+- required: false
+
 ### `--pull-request-title`
 
 Pull request title template
@@ -80,7 +87,7 @@ Available tokens and permissions required for each token are as follows.
 
 - [GitHub Actions](https://docs.github.com/en/actions/security-guides/automatic-token-authentication)
 - [GitHub App](https://docs.github.com/en/developers/apps/building-github-apps/authenticating-with-github-apps)
-  - Contents: Read-only
+  - Contents: Read & write
   - Metadata: Read-only
   - Pull requests: Read & write
 - [Personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
@@ -104,7 +111,7 @@ Creating a GitHub App may be tedious, but you only have to do it once the first
 
 ## Examples
 
-- Use token of GitHub Actions
+- [Use token of GitHub Actions](https://github.com/npm-update-package/example-github-actions)
 
 ```yaml
 name: npm-update-package
@@ -127,8 +134,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
-
-- Use token of GitHub App
+- [Use token of GitHub App](https://github.com/npm-update-package/example-github-app)
 
 ```yaml
 name: npm-update-package
@@ -159,12 +165,61 @@ jobs:
           GITHUB_TOKEN: ${{ steps.generate_token.outputs.token }}
 ```
 
-Actual working examples can be seen in these repositories.
+- [Use Personal access token](https://github.com/npm-update-package/example-pat)
+
+```yaml
+name: npm-update-package
+on:
+  schedule:
+    - cron: '0 0 * * *'
+jobs:
+  npm-update-package:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+      - run: |
+          git config user.name $GIT_USER_NAME
+          git config user.email $GIT_USER_EMAIL
+          npx npm-update-package --github-token $GITHUB_TOKEN
+        env:
+          # TODO: Replace with your email
+          GIT_USER_EMAIL: 97961304+npm-update-package-bot@users.noreply.github.com
+          # TODO: Replace with your name
+          GIT_USER_NAME: npm-update-package-bot
+          GITHUB_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+```
+
+- [Use Yarn](https://github.com/npm-update-package/example-yarn)
 
-|Repository|Package manager|GitHub token|
-|---|---|---|
-|[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|
+```yaml
+name: npm-update-package
+on:
+  schedule:
+    - cron: '0 0 * * *'
+jobs:
+  npm-update-package:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+      - name: Generate token
+        id: generate_token
+        uses: tibdex/github-app-token@v1
+        with:
+          app_id: ${{ secrets.APP_ID }}
+          private_key: ${{ secrets.PRIVATE_KEY }}
+      - run: |
+          git config user.name $GIT_USER_NAME
+          git config user.email $GIT_USER_EMAIL
+          npx npm-update-package --github-token $GITHUB_TOKEN --package-manager yarn
+        env:
+          # TODO: Replace with your GitHub App's email
+          GIT_USER_EMAIL: 97396142+npm-update-package-bot[bot]@users.noreply.github.com
+          # TODO: Replace with your GitHub App's user name
+          GIT_USER_NAME: npm-update-package-bot[bot]
+          GITHUB_TOKEN: ${{ steps.generate_token.outputs.token }}
+```
 
 ## Flow
 

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.24.0',
+    version: '0.25.0',
     web: 'https://github.com/npm-update-package/npm-update-package'
 };

package/dist/github/GitHub.js

@@ -47,5 +47,13 @@ class GitHub {
         const { data } = await this.octokit.repos.get(params);
         return data;
     }
+    async requestReviewers({ owner, repo, pullNumber, reviewers }) {
+        await this.octokit.pulls.requestReviewers({
+            owner,
+            repo,
+            pull_number: pullNumber,
+            reviewers
+        });
+    }
 }
 exports.GitHub = GitHub;

package/dist/github/pull-request/creator/PullRequestCreator.js

@@ -3,12 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PullRequestCreator = void 0;
 const createPullRequestBody_1 = require("./createPullRequestBody");
 class PullRequestCreator {
-    constructor({ github, gitRepo, githubRepo, pullRequestTitleCreator, logger }) {
+    constructor({ github, gitRepo, githubRepo, pullRequestTitleCreator, logger, reviewers }) {
         this.github = github;
         this.gitRepo = gitRepo;
         this.githubRepo = githubRepo;
         this.pullRequestTitleCreator = pullRequestTitleCreator;
         this.logger = logger;
+        this.reviewers = reviewers;
     }
     async create({ outdatedPackage, branchName }) {
         const title = this.pullRequestTitleCreator.create(outdatedPackage);
@@ -30,6 +31,14 @@ class PullRequestCreator {
             issue_number: pullRequest.number,
             labels: ['npm-update-package']
         });
+        if (this.reviewers !== undefined) {
+            await this.github.requestReviewers({
+                owner: this.gitRepo.owner,
+                repo: this.gitRepo.name,
+                pullNumber: pullRequest.number,
+                reviewers: this.reviewers
+            });
+        }
         return pullRequest;
     }
 }

package/dist/main.js

@@ -56,7 +56,8 @@ const main = async ({ options, logger }) => {
         gitRepo,
         githubRepo,
         pullRequestTitleCreator,
-        logger
+        logger,
+        reviewers: options.pullRequestReviewers
     });
     const commitMessageCreator = new git_1.CommitMessageCreator(options.commitMessage);
     const pullRequestFinder = new github_1.PullRequestFinder(pullRequests);

package/dist/options/Options.js

@@ -4,11 +4,16 @@ exports.isOptions = void 0;
 const io_ts_1 = require("io-ts");
 const logger_1 = require("../logger");
 const package_manager_1 = require("../package-manager");
-const Options = (0, io_ts_1.type)({
-    commitMessage: io_ts_1.string,
-    githubToken: io_ts_1.string,
-    logLevel: (0, io_ts_1.union)([(0, io_ts_1.literal)(logger_1.LogLevel.Off), (0, io_ts_1.literal)(logger_1.LogLevel.Error), (0, io_ts_1.literal)(logger_1.LogLevel.Info), (0, io_ts_1.literal)(logger_1.LogLevel.Debug)]),
-    packageManager: (0, io_ts_1.union)([(0, io_ts_1.literal)(package_manager_1.PackageManagerName.Npm), (0, io_ts_1.literal)(package_manager_1.PackageManagerName.Yarn)]),
-    pullRequestTitle: io_ts_1.string
-});
+const Options = (0, io_ts_1.intersection)([
+    (0, io_ts_1.type)({
+        commitMessage: io_ts_1.string,
+        githubToken: io_ts_1.string,
+        logLevel: (0, io_ts_1.union)([(0, io_ts_1.literal)(logger_1.LogLevel.Off), (0, io_ts_1.literal)(logger_1.LogLevel.Error), (0, io_ts_1.literal)(logger_1.LogLevel.Info), (0, io_ts_1.literal)(logger_1.LogLevel.Debug)]),
+        packageManager: (0, io_ts_1.union)([(0, io_ts_1.literal)(package_manager_1.PackageManagerName.Npm), (0, io_ts_1.literal)(package_manager_1.PackageManagerName.Yarn)]),
+        pullRequestTitle: io_ts_1.string
+    }),
+    (0, io_ts_1.partial)({
+        pullRequestReviewers: (0, io_ts_1.array)(io_ts_1.string)
+    })
+]);
 exports.isOptions = Options.is;

package/dist/options/cliOptions.js

@@ -42,6 +42,12 @@ exports.cliOptions = [
         ],
         default: package_manager_1.PackageManagerName.Npm
     },
+    {
+        name: 'pull-request-reviewers',
+        description: 'Reviewers of pull request',
+        type: OptionType_1.OptionType.StringArray,
+        required: false
+    },
     {
         name: 'pull-request-title',
         description: 'Pull request title template',

package/dist/package-manager/PackageManagerName.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isPackageManagerName = exports.PackageManagerName = void 0;
 exports.PackageManagerName = {
     Npm: 'npm',
-    Yarn: 'Yarn'
+    Yarn: 'yarn'
 };
 const packageManagerNames = Object.values(exports.PackageManagerName);
 const isPackageManagerName = (value) => packageManagerNames.includes(value);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "0.24.0",
+  "version": "0.25.0",
   "description": "CLI tool for creating pull requests to update npm packages",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -47,7 +47,7 @@
     "eslint-plugin-tsdoc": "0.2.14",
     "husky": "7.0.4",
     "jest": "27.4.7",
-    "lint-staged": "12.1.7",
+    "lint-staged": "12.2.0",
     "npm-run-all": "4.1.5",
     "rimraf": "3.0.2",
     "ts-jest": "27.1.3",