cfpb-chart-builder - npm Package Compare versions

Comparing version 5.1.1 to 5.1.2

package.json

 {
   "name": "cfpb-chart-builder",
-  "version": "5.1.1",
+  "version": "5.1.2",
   "description": "Charts for the Consumer Financial Protection Bureau",
@@ -5,0 +5,0 @@ "main": "src/js/index.js",

README.md

@@ -139,3 +139,3 @@
   __NOTE:__ To re-install and rebuild all the site’s assets run
-  `./setup.sh` again. See the [usage](#usage) section on updating all the
+  `./setup.sh` again. See the [usage](#development-usage) section on updating all the
   project dependencies.
@@ -149,9 +149,26 @@
 
-To watch for changes in the source code and automatically update the running site,
-open a terminal and run:
+To run the site on a local server,
+run `gulp watch` from the project root.
+Running in this manner will also watch for changes in the source code
+and automatically update the running site.
 
-```bash
-gulp watch
-```
+### Publish a release
 
+1. After merging all PRs needed for release, update the version in `package.json` using [semantic versioning](https://semver.org) and commit it:
+   ```
+   npm version patch
+   git commit -m 'describe the version upgrade'
+   ```
+1. Tag the repo with the new version number. This example tags a release as `v5.1.2` and then pushes the tag to Github:
+   ```
+   git tag -a v5.1.2 -m 'description of what is in the release'
+   git push upstream master --tags
+   ```
+1. Create a new release description on Github at https://github.com/cfpb/cfpb-chart-builder/releases/new using your new tag.
+1. Publish to npm:
+   ```
+   npm publish
+   ```
+
+
 ## Testing
@@ -161,3 +178,4 @@
 
-Sauce Labs is used to test the charts in IE 8 through 10.
+Sauce Labs is used to test the charts in IE 10.
+_(Note: This is not working correctly as of 1/24/19.)_
 An [Open Sauce](https://saucelabs.com/open-source) account has been created for this repo.
@@ -171,3 +189,3 @@ Its credentials can be found at https://GHE/gist/contolini/504ea71f6a19c74090c7a150aff60421.
 The browser tests will take several minutes to run.
-The test script simply loads `http://localhost:8089/test` in IE VMs and reports any `window` errors.
+The test script simply loads `http://localhost:8089/` in IE VMs and reports any `window` errors.
 
@@ -174,0 +192,0 @@ ## Getting help

src/js/charts/BarChart.js

@@ -31,3 +31,4 @@ import Highcharts from 'highcharts/js/highstock';
         floating: true,
-        selected: 'all',
+        // The index of the button to appear pre-selected.
+        selected: 2,
         height: 35,
@@ -62,6 +63,2 @@ inputEnabled: false,
             text: '5y'
-          },
-          {
-            type: 'all',
-            text: 'All'
           }
@@ -68,0 +65,0 @@ ]

src/js/charts/LineChart.js

@@ -81,3 +81,4 @@ import Highcharts from 'highcharts/js/highstock';
         floating: true,
-        selected: 'all',
+        // The index of the button to appear pre-selected.
+        selected: 2,
         height: 35,
@@ -84,0 +85,0 @@ inputEnabled: false,

src/js/charts/LineChartIndex.js

@@ -31,3 +31,4 @@ import Highcharts from 'highcharts/js/highstock';
         floating: true,
-        selected: 'all',
+        // The index of the button to appear pre-selected.
+        selected: 2,
         height: 35,
@@ -34,0 +35,0 @@ inputEnabled: false,

test/browser-tests.js

@@ -80,3 +80,3 @@ const path = require( 'path' );
       platforms: [
-        [ 'Windows 7', 'internet explorer', '10' ],
+        [ 'Windows 7', 'internet explorer', '11' ],
         [ 'Windows 7', 'firefox', '27' ],
@@ -83,0 +83,0 @@ [ 'Windows 7', 'chrome', '' ],

No alert changes

Improved metrics

Total package byte prevSize

4381489

increased by0.02%

Number of lines in readme file

209

increased by9.42%

Worsened metrics

Lines of code

41061

No dependency changes