npm-update-package 0.24.1 → 0.24.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -10
- package/dist/app.js +1 -1
- package/dist/package-manager/PackageManagerName.js +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -14,7 +14,7 @@ npx npm-update-package --github-token $GITHUB_TOKEN
|
|
|
14
14
|
## Options
|
|
15
15
|
|
|
16
16
|
You can customize behavior via command-line options.
|
|
17
|
-
|
|
17
|
+
Some options can embed variables like `{{packageName}}`(HTML-escaped) or `{{{packageName}}}`(not HTML-escaped).
|
|
18
18
|
|
|
19
19
|
### `--commit-message`
|
|
20
20
|
|
|
@@ -31,7 +31,7 @@ Commit message template
|
|
|
31
31
|
|
|
32
32
|
### `--github-token`
|
|
33
33
|
|
|
34
|
-
[GitHub token](#github-token)
|
|
34
|
+
[GitHub token](#github-token)
|
|
35
35
|
|
|
36
36
|
- type: string
|
|
37
37
|
- required: true
|
|
@@ -104,7 +104,7 @@ Creating a GitHub App may be tedious, but you only have to do it once the first
|
|
|
104
104
|
|
|
105
105
|
## Examples
|
|
106
106
|
|
|
107
|
-
- Use token of GitHub Actions
|
|
107
|
+
- [Use token of GitHub Actions](https://github.com/npm-update-package/example-github-actions)
|
|
108
108
|
|
|
109
109
|
```yaml
|
|
110
110
|
name: npm-update-package
|
|
@@ -127,8 +127,7 @@ jobs:
|
|
|
127
127
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
128
128
|
```
|
|
129
129
|
|
|
130
|
-
|
|
131
|
-
- Use token of GitHub App
|
|
130
|
+
- [Use token of GitHub App](https://github.com/npm-update-package/example-github-app)
|
|
132
131
|
|
|
133
132
|
```yaml
|
|
134
133
|
name: npm-update-package
|
|
@@ -159,12 +158,30 @@ jobs:
|
|
|
159
158
|
GITHUB_TOKEN: ${{ steps.generate_token.outputs.token }}
|
|
160
159
|
```
|
|
161
160
|
|
|
162
|
-
|
|
161
|
+
- [Use Personal access token](https://github.com/npm-update-package/example-pat)
|
|
163
162
|
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
163
|
+
```yaml
|
|
164
|
+
name: npm-update-package
|
|
165
|
+
on:
|
|
166
|
+
schedule:
|
|
167
|
+
- cron: '0 0 * * *'
|
|
168
|
+
jobs:
|
|
169
|
+
npm-update-package:
|
|
170
|
+
runs-on: ubuntu-latest
|
|
171
|
+
steps:
|
|
172
|
+
- uses: actions/checkout@v2
|
|
173
|
+
- uses: actions/setup-node@v2
|
|
174
|
+
- run: |
|
|
175
|
+
git config user.name $GIT_USER_NAME
|
|
176
|
+
git config user.email $GIT_USER_EMAIL
|
|
177
|
+
npx npm-update-package --github-token $GITHUB_TOKEN
|
|
178
|
+
env:
|
|
179
|
+
# TODO: Replace with your email
|
|
180
|
+
GIT_USER_EMAIL: 97961304+npm-update-package-bot@users.noreply.github.com
|
|
181
|
+
# TODO: Replace with your name
|
|
182
|
+
GIT_USER_NAME: npm-update-package-bot
|
|
183
|
+
GITHUB_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
|
|
184
|
+
```
|
|
168
185
|
|
|
169
186
|
## Flow
|
|
170
187
|
|
package/dist/app.js
CHANGED
|
@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.isPackageManagerName = exports.PackageManagerName = void 0;
|
|
4
4
|
exports.PackageManagerName = {
|
|
5
5
|
Npm: 'npm',
|
|
6
|
-
Yarn: '
|
|
6
|
+
Yarn: 'yarn'
|
|
7
7
|
};
|
|
8
8
|
const packageManagerNames = Object.values(exports.PackageManagerName);
|
|
9
9
|
const isPackageManagerName = (value) => packageManagerNames.includes(value);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "npm-update-package",
|
|
3
|
-
"version": "0.24.
|
|
3
|
+
"version": "0.24.2",
|
|
4
4
|
"description": "CLI tool for creating pull requests to update npm packages",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "tsc --project tsconfig.build.json",
|
|
@@ -47,7 +47,7 @@
|
|
|
47
47
|
"eslint-plugin-tsdoc": "0.2.14",
|
|
48
48
|
"husky": "7.0.4",
|
|
49
49
|
"jest": "27.4.7",
|
|
50
|
-
"lint-staged": "12.
|
|
50
|
+
"lint-staged": "12.2.0",
|
|
51
51
|
"npm-run-all": "4.1.5",
|
|
52
52
|
"rimraf": "3.0.2",
|
|
53
53
|
"ts-jest": "27.1.3",
|