Skip to content

Upgrade to highcharts 7 #162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cfarm merged 4 commits into from
Mar 28, 2019
Merged

Upgrade to highcharts 7 #162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ab8b7bc
Upgrade to highcharts 7
anselmbradford Dec 11, 2018
a48f434
Adjust styles
anselmbradford Dec 11, 2018
f0e28d9
Adjust axis labels
anselmbradford Dec 11, 2018
3c66655
Merge branch 'master' into upgrade_to_highcharts_7
cfarm Mar 14, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 26 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ for more details.
3. Install the dependencies and compile the project with: `./setup.sh`

__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.

### Development usage
Expand All @@ -145,18 +145,36 @@ Each time you fetch from the upstream repository (this repo), run `./setup.sh`.
This setup script will remove and re-install the project dependencies and
rebuild the site's JavaScript and CSS assets.

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.

### 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
```

```bash
gulp watch
```

## Testing

`npm test` will run unit and browser tests.

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.
Its credentials can be found at https://GHE/gist/contolini/504ea71f6a19c74090c7a150aff60421.
Add the credentials locally by doing:
Expand All @@ -165,7 +183,7 @@ Add the credentials locally by doing:
1. Add valid Sauce Labs credentials to `test/config.json` (see above gist).

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.

## Getting help

Expand Down
Loading