npm-update-package 0.24.2 → 0.26.1

package/README.md

@@ -57,7 +57,7 @@ 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-title`
@@ -73,6 +73,13 @@ Pull request title template
   - `level`: semver level (major/minor/patch)
 - default: `chore(deps): {{level}} update {{{packageName}}} to v{{newVersion}}`
 
+### `--reviewers`
+
+User names to request reviews
+
+- type: string[]
+- required: false
+
 ## GitHub token
 
 GitHub token is required to run npm-update-package.  
@@ -152,9 +159,9 @@ jobs:
           npx npm-update-package --github-token $GITHUB_TOKEN
         env:
           # TODO: Replace with your GitHub App's email
-          GIT_USER_EMAIL: 97396142+npm-update-package-bot[bot]@users.noreply.github.com
+          GIT_USER_EMAIL: 97396142+npm-update-package[bot]@users.noreply.github.com
           # TODO: Replace with your GitHub App's user name
-          GIT_USER_NAME: npm-update-package-bot[bot]
+          GIT_USER_NAME: npm-update-package[bot]
           GITHUB_TOKEN: ${{ steps.generate_token.outputs.token }}
 ```
 
@@ -183,6 +190,37 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
 ```
 
+- [Use Yarn](https://github.com/npm-update-package/example-yarn)
+
+```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]@users.noreply.github.com
+          # TODO: Replace with your GitHub App's user name
+          GIT_USER_NAME: npm-update-package[bot]
+          GITHUB_TOKEN: ${{ steps.generate_token.outputs.token }}
+```
+
 ## Flow
 
 The following shows the process flow of npm-update-package.

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

package/dist/github/GitHub.js

@@ -6,18 +6,32 @@ class GitHub {
     constructor(octokit) {
         this.octokit = octokit;
     }
-    async addLabels(params) {
-        const { data } = await this.octokit.issues.addLabels(params);
+    async addLabels({ owner, repo, issueNumber, labels }) {
+        const { data } = await this.octokit.issues.addLabels({
+            owner,
+            repo,
+            issue_number: issueNumber,
+            labels
+        });
         return data;
     }
-    async closePullRequest(params) {
+    async closePullRequest({ owner, repo, pullNumber }) {
         await this.octokit.pulls.update({
-            ...params,
+            owner,
+            repo,
+            pull_number: pullNumber,
             state: 'closed'
         });
     }
-    async createPullRequest(params) {
-        const { data } = await this.octokit.pulls.create(params);
+    async createPullRequest({ owner, repo, baseBranch, headBranch, title, body }) {
+        const { data } = await this.octokit.pulls.create({
+            owner,
+            repo,
+            base: baseBranch,
+            head: headBranch,
+            title,
+            body
+        });
         return data;
     }
     async deleteBranch({ owner, repo, branch }) {
@@ -28,24 +42,37 @@ class GitHub {
         });
     }
     // TODO: fetch all branches with page option
-    async fetchBranches(params) {
+    async fetchBranches({ owner, repo }) {
         const { data } = await this.octokit.repos.listBranches({
-            ...params,
+            owner,
+            repo,
             per_page: 100
         });
         return data;
     }
     // TODO: fetch all pull requests with page option
-    async fetchPullRequests(params) {
+    async fetchPullRequests({ owner, repo }) {
         const { data } = await this.octokit.pulls.list({
-            ...params,
+            owner,
+            repo,
             per_page: 100
         });
         return data;
     }
-    async fetchRepository(params) {
-        const { data } = await this.octokit.repos.get(params);
+    async fetchRepository({ owner, repo }) {
+        const { data } = await this.octokit.repos.get({
+            owner,
+            repo
+        });
         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/closer/PullRequestCloser.js

@@ -9,7 +9,7 @@ class PullRequestCloser {
         await this.github.closePullRequest({
             owner: pullRequest.base.repo.owner.login,
             repo: pullRequest.base.repo.name,
-            pull_number: pullRequest.number
+            pullNumber: pullRequest.number
         });
         await this.github.deleteBranch({
             owner: pullRequest.base.repo.owner.login,

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);
@@ -18,8 +19,8 @@ class PullRequestCreator {
         const pullRequest = await this.github.createPullRequest({
             owner: this.gitRepo.owner,
             repo: this.gitRepo.name,
-            base: this.githubRepo.default_branch,
-            head: branchName,
+            baseBranch: this.githubRepo.default_branch,
+            headBranch: branchName,
             title,
             body
         });
@@ -27,9 +28,17 @@ class PullRequestCreator {
         await this.github.addLabels({
             owner: this.gitRepo.owner,
             repo: this.gitRepo.name,
-            issue_number: pullRequest.number,
+            issueNumber: 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.reviewers
     });
     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)({
+        reviewers: (0, io_ts_1.array)(io_ts_1.string)
+    })
+]);
 exports.isOptions = Options.is;

package/dist/options/cliOptions.js

@@ -48,5 +48,11 @@ exports.cliOptions = [
         type: OptionType_1.OptionType.String,
         required: false,
         default: 'chore(deps): {{level}} update {{{packageName}}} to v{{newVersion}}'
+    },
+    {
+        name: 'reviewers',
+        description: 'User names to request reviews',
+        type: OptionType_1.OptionType.StringArray,
+        required: false
     }
 ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "0.24.2",
+  "version": "0.26.1",
   "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.2.0",
+    "lint-staged": "12.2.1",
     "npm-run-all": "4.1.5",
     "rimraf": "3.0.2",
     "ts-jest": "27.1.3",