@adobe/sizewatcher 1.2.1 → 1.3.0

package/README.md

@@ -14,7 +14,7 @@
 - [Requirements](#requirements)
 - [Installation](#installation)
 - [Usage](#usage)
-- [CI Setup](#ci-setup)
+- [**CI Setup**](#ci-setup)
 - [Configuration](#configuration)
 - [Comparators reference](#comparators-reference)
 - [Contribute](#contribute)
@@ -33,6 +33,8 @@ While any custom file or folder path can be measured via configuration, various
 
 `sizewatcher` runs as part of your CI and reports results as comment on the pull request or as github commit status (optional), allowing to block PRs if a certain threshold was exceeded.
 
+:warning: **The git size comparison feature (the `git` comparator) is currently not calculating correct values (as of 1.2.1). See [issue #52](https://github.com/adobe/sizewatcher/issues/52) for more details.**
+
 This is an example of a `sizewatcher` Github PR comment with a failure (ignore the small numbers):
 
 ---
@@ -125,7 +127,7 @@ By default `sizewatcher` will
 
 ## Requirements
 
-- [Nodejs](https://nodejs.org) version 10+
+- [Nodejs](https://nodejs.org) version 12+ (since 1.3.0)
   - recommended to use latest stable version "LTS"
 - Github or Github Enterprise
   - if you want to run it on pull requests
@@ -137,12 +139,14 @@ By default `sizewatcher` will
 
 ## Installation
 
-You can install the `sizewatcher` tool locally for testing or checking your changes before committing:
+Local: You can install the `sizewatcher` tool locally for testing or checking your changes before committing:
 
 ```
 npm install -g @adobe/sizewatcher
 ```
 
+For setup in Continuous Integration: see [CI Setup](#ci-setup) section.
+
 ## Usage
 
 When run locally, `sizewatcher` will output its results on the command line.
@@ -230,7 +234,7 @@ npx @adobe/sizewatcher
 This command will always use the latest published version. In some cases it might be (temporarily) desireable to stick to a certain version, which can be achieved using:
 
 ```
-npx @adobe/sizewatcher@1.0.0
+npx @adobe/sizewatcher@1.2.1
 ```
 
 #### GITHUB_TOKEN
@@ -289,7 +293,7 @@ jobs:
 
 For [Travis CI](https://travis-ci.org) you need to
 - use `language: node_js`
-  - if you already use a different language, find a way to ensure Nodejs 10+ is installed
+  - if you already use a different language, find a way to ensure Nodejs 12+ is installed
 - under `script` run `npx @adobe/sizewatcher`
 - set a secret environment variable `GITHUB_TOKEN` in the [Travis repository settings](https://docs.travis-ci.com/user/environment-variables/#defining-variables-in-repository-settings) with a github token with permission to comment on PRs and reporting commit statuses for the repository
 
@@ -309,7 +313,7 @@ script:
 ### CircleCI
 
 For [CircleCI](https://circleci.com) you need to
-- use a docker image with Nodejs 10+ installed
+- use a docker image with Nodejs 12+ installed
   - alternatively install [using nvm](https://www.google.com/search?q=circleci+use+nvm)
 - run `npx @adobe/sizewatcher`
 - set a secret environment variable `GITHUB_TOKEN` in the [CircleCI project settings](https://circleci.com/docs/2.0/env-vars/#setting-an-environment-variable-in-a-project) (or in a [Context](https://circleci.com/docs/2.0/env-vars/#setting-an-environment-variable-in-a-context)) with a github token with permission to comment on PRs and reporting commit statuses for the repository
@@ -334,7 +338,7 @@ jobs:
 
 This is not tested well but might work.
 
-Ensure Nodejs 10+ is installed.
+Ensure Nodejs 12+ is installed.
 
 Set these environment variables in the CI job:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/sizewatcher",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "Warns if your pull requests introduce large size increases.",
   "main": "index.js",
   "bin": {
@@ -28,7 +28,7 @@
     "@adobe/eslint-config-asset-compute": "^1.3.0",
     "coveralls": "^3.1.0",
     "eslint": "^7.1.0",
-    "mocha": "^7.2.0",
+    "mocha": "^10.2.0",
     "mock-fs": "^4.13.0",
     "nyc": "^15.1.0",
     "supports-color": "^8.1.1"