npm-update-package 0.23.1 → 0.24.2

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,8 +31,7 @@ Commit message template
 
 ### `--github-token`
 
-GitHub token.  
-See more in [GitHub token](#github-token) section.
+[GitHub token](#github-token)
 
 - type: string
 - required: true
@@ -58,7 +57,7 @@ Package manager of your project
 - required: false
 - allowed values
   - `npm`: npm
-  - `yarn`: Yarn
+  - `yarn`: Yarn (**It has not been tested yet.**)
 - default: `npm`
 
 ### `--pull-request-title`
@@ -81,7 +80,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)
@@ -105,7 +104,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
@@ -128,8 +127,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
@@ -160,12 +158,30 @@ 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)
 
-|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
+      - 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 }}
+```
 
 ## 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.23.1',
+    version: '0.24.2',
     web: 'https://github.com/npm-update-package/npm-update-package'
 };

package/dist/github/GitHub.js

@@ -20,6 +20,13 @@ class GitHub {
         const { data } = await this.octokit.pulls.create(params);
         return data;
     }
+    async deleteBranch({ owner, repo, branch }) {
+        await this.octokit.git.deleteRef({
+            owner,
+            repo,
+            ref: `heads/${branch}`
+        });
+    }
     // TODO: fetch all branches with page option
     async fetchBranches(params) {
         const { data } = await this.octokit.repos.listBranches({

package/dist/github/createGitHub.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createGitHub = void 0;
 const createOctokit_1 = require("./createOctokit");
 const GitHub_1 = require("./GitHub");
-// TODO: add test
 const createGitHub = ({ repository, token }) => {
     const octokit = (0, createOctokit_1.createOctokit)({
         repository,

package/dist/github/pull-request/closer/PullRequestCloser.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PullRequestCloser = void 0;
-// TODO: Add test
 class PullRequestCloser {
     constructor(github) {
         this.github = github;
@@ -12,6 +11,11 @@ class PullRequestCloser {
             repo: pullRequest.base.repo.name,
             pull_number: pullRequest.number
         });
+        await this.github.deleteBranch({
+            owner: pullRequest.base.repo.owner.login,
+            repo: pullRequest.base.repo.name,
+            branch: pullRequest.head.ref
+        });
     }
 }
 exports.PullRequestCloser = PullRequestCloser;

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.23.1",
+  "version": "0.24.2",
   "description": "CLI tool for creating pull requests to update npm packages",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -37,7 +37,7 @@
     "@types/node": "12.20.40",
     "@types/parse-github-url": "1.0.0",
     "@types/semver": "7.3.9",
-    "@typescript-eslint/eslint-plugin": "5.9.1",
+    "@typescript-eslint/eslint-plugin": "5.10.0",
     "eslint": "8.7.0",
     "eslint-config-standard-with-typescript": "21.0.1",
     "eslint-plugin-import": "2.25.4",
@@ -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",