npm-update-package 0.11.0 → 0.11.1

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.
Files changed (3) hide show
  1. package/README.md +27 -18
  2. package/dist/app.js +1 -1
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -13,31 +13,40 @@ This package is currently under development, so the major version is 0 yet.
13
13
 
14
14
  - Git v2.23.0 or higher
15
15
 
16
- ## Installation
17
-
18
- If you are using npm:
16
+ ## Usage
19
17
 
20
18
  ```sh
21
- npm i -g npm-update-package
19
+ npx npm-update-package --github-token $GITHUB_TOKEN
22
20
  ```
23
21
 
24
- If you are using Yarn:
25
-
26
- ```sh
27
- yarn global add npm-update-package
22
+ ## Examples
23
+
24
+ Example of running npm-update-package on GitHub Actions at 0:00 every day:
25
+
26
+ ```yaml
27
+ name: npm-update-package
28
+ on:
29
+ schedule:
30
+ - cron: '0 0 * * *'
31
+ jobs:
32
+ npm-update-package:
33
+ runs-on: ubuntu-latest
34
+ steps:
35
+ - uses: actions/checkout@v2
36
+ - uses: actions/setup-node@v2
37
+ - run: |
38
+ git config user.name $GIT_USER_NAME
39
+ git config user.email $GIT_USER_EMAIL
40
+ npx npm-update-package --github-token $GITHUB_TOKEN
41
+ env:
42
+ GIT_USER_EMAIL: 41898282+github-actions[bot]@users.noreply.github.com
43
+ GIT_USER_NAME: github-actions[bot]
44
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
28
45
  ```
29
46
 
30
- Or, you can use [npx](https://docs.npmjs.com/cli/v8/commands/npx).
47
+ Actual working examples can be seen in these repositories.
31
48
 
32
- ```sh
33
- npx npm-update-package
34
- ```
35
-
36
- ## Usage
37
-
38
- ```sh
39
- npm-update-package --github-token $GITHUB_TOKEN
40
- ```
49
+ - [npm-update-package/example-npm](https://github.com/npm-update-package/example-npm)
41
50
 
42
51
  ## Options
43
52
 
package/dist/app.js CHANGED
@@ -3,6 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.app = void 0;
4
4
  exports.app = {
5
5
  name: 'npm-update-package',
6
- version: '0.11.0',
6
+ version: '0.11.1',
7
7
  web: 'https://github.com/npm-update-package/npm-update-package'
8
8
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "npm-update-package",
3
- "version": "0.11.0",
3
+ "version": "0.11.1",
4
4
  "description": "CLI tool for creating pull request to update npm packages",
5
5
  "scripts": {
6
6
  "build": "tsc --project tsconfig.build.json",