ci-npm-update - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

lib/compare_view.d.ts

@@ -5,10 +5,10 @@ import { NpmConfig } from "./npm_config";
         url: string;
-    }): string;
+    }): string | null;
     name: string;
-    installedVersion: string;
-    latestVersion: string;
-    repositoryUrl: string;
-    constructor(installedVersion: string, latestVersion: string, npmConfig: NpmConfig);
+    installedVersion: string | null;
+    latestVersion: string | null;
+    repositoryUrl: string | null;
+    constructor(installedVersion: string | null, latestVersion: string | null, npmConfig: NpmConfig);
     hasRepositoryUrl(): boolean;
-    getRepositoryUrl(): string;
+    getRepositoryUrl(): string | null;
     hasDiffUrl(): boolean;
@@ -15,0 +15,0 @@ getVersionRange(): string;

lib/issue.js

 // to file an issue from a package info list
 "use strict";
-const SIGNATURE = "[ci-npm-update](https://github.com/gfx/ci-npm-update)";
+const SIGNATURE = "[bitjourney/ci-npm-update](https://github.com/bitjourney/ci-npm-update)";
 function createBody(list, npmConfigPromise) {
@@ -67,3 +67,6 @@ return npmConfigPromise.then((npmConfig) => {
     }
+    else {
+        return `* ${c.name}`;
+    }
 }
 //# sourceMappingURL=issue.js.map

package.json

 {
   "name": "ci-npm-update",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Keep NPM dependencies up-to-date with CI, providing version-to-version diff for each library",
@@ -32,3 +32,3 @@ "repository": {
     "@types/node": "^4.0.30",
-    "@types/request": "0.0.27",
+    "@types/request": "^0.0.28",
     "moment": "^2.14.1",
@@ -39,7 +39,7 @@ "request": "^2.73.0"
     "@types/mocha": "^2.2.28",
-    "@types/power-assert": "0.0.27",
+    "@types/power-assert": "^0.0.27",
     "mocha": "^2.5.1",
     "power-assert": "^1.4.1",
     "source-map-support": "^0.4.0",
-    "to-iso-string": "0.0.2",
+    "to-iso-string": "^0.0.2",
     "ts-node": "^1.2.1",
@@ -46,0 +46,0 @@ "tslint": "^3.13.0",

README.md

@@ -1,30 +0,57 @@
-# ci-npm-update [![CircleCI](https://circleci.com/gh/gfx/ci-npm-update.svg?style=svg)](https://circleci.com/gh/gfx/ci-npm-update)
+# ci-npm-update [![CircleCI](https://circleci.com/gh/bitjourney/ci-npm-update.svg?style=svg)](https://circleci.com/gh/bitjourney/ci-npm-update)
 
-This command keeps npm dependencies up-to-date, making pull-requests from CI.
+This command keeps npm dependencies up-to-date by making pull-requests from CI.
 
 For example: https://github.com/gfx/ci-npm-update/pull/13
 
+![](doc-assets/ci-npm-update-pr.png)
+
+This is inspired by [circleci-bundle-update-pr](https://github.com/masutaka/circleci-bundle-update-pr).
+
+# Install
+
+```sh
+npm install --dev ci-npm-update
+```
+
 # Usage
 
-For CI:
+## Configuration
 
-```
-# setup env vars in the CI dashboard:
+This command is designed to be executed by CI nightly builds.
+
+Set `GITHUB_ACCESS_TOKEN` environment to make a pull-requesto to github repositories,
+and set SSH keys to push to the repos from CI.
+
+If the CI environment has no git configuration, also set `GIT_USER_NAME` and `GIT_USER_EMAIL`
+to commit patches in CI.
+
+```sh
 export GITHUB_ACCESS_TOKEN=...
 export GIT_USER_NAME=gfx
 export GIT_USER_EMAIL=[e-mail]
+```
 
-# and later:
+## Execution
+
+By default, `ci-npm-update` runs in dry-run mode. Set `--execute` to make pull-requests.
+
+```sh
 ci-npm-update --execute
 ```
 
-For local use:
+## Local Tests
 
+If you only run it in dry-run mode, no configuration is required:
+
 ```
-# envchain is recommended to save credentils locally
-envchain --set github GITHUB_ACCESS_TOKEN
-
 # run in dry-run mode:
-envchain github ci-npm-update
+ci-npm-update
+```
 
+If you want to make pull-requests in your local machine, use `GITHUB_ACCESS_TOKEN`:
+
+```
+# envchain is recommended
+envchain --set github GITHUB_ACCESS_TOKEN
 # run:
@@ -54,9 +81,11 @@ envchain github ci-npm-update --execute
 
-# See Also
+To test it, run the following command:
 
-* [circleci-bundle-update-pr](https://github.com/masutaka/circleci-bundle-update-pr)
+```sh
+heroku run './build-circleci'
+```
 
 # License
 
-Copyright (c) 2016 FUJI Goro (gfx).
+Copyright (c) 2016 Bit Journey, Inc.
 
@@ -63,0 +92,0 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

tsconfig.json

@@ -9,2 +9,3 @@ {
         "noUnusedParameters": true,
+        "strictNullChecks": true,
         "declaration": true,
@@ -11,0 +12,0 @@ "sourceMap": true,

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

157138

increased by7.99%

Number of package files

86

increased by2.38%

Lines of code

1769

increased by0.23%

Number of lines in readme file

96

increased by43.28%

Dependency changes

• + Added@types/node@6.0.118(transitive)

• + Added@types/request@0.0.28(transitive)

• - Removed@types/node@4.0.48(transitive)

• - Removed@types/request@0.0.27(transitive)

• Updated@types/request@^0.0.28