Skip to content

Commit

Permalink
Merge d0821d6 into a4b3bd4
Browse files Browse the repository at this point in the history
  • Loading branch information
nrabinowitz committed May 15, 2021
2 parents a4b3bd4 + d0821d6 commit 3e091ef
Show file tree
Hide file tree
Showing 5 changed files with 92 additions and 60 deletions.
74 changes: 74 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
name: test

on:
push:
branches: [master]
pull_request:
branches: [master]

jobs:

# Run quick tests for all Node versions
version-tests:
name: Test Node ${{ matrix.node_version }}
runs-on: ubuntu-latest

strategy:
matrix:
node_version: [6, 8, 10, 14]

steps:
- uses: actions/checkout@v2.1.1

- uses: actions/setup-node@v2
with:
node-version: '${{ matrix.node_version }}'

- name: Install
run: |
yarn --ignore-engines
- name: Tests
run: |
yarn test-fast
# Run the full CI suite for the dev Node version. Tests are expected to pass for all
# Node versions, but the build only needs to work for the development version, which
# should match the Volta config in package.json
build-tests:
name: Build Test Node ${{ matrix.node_version }}
runs-on: ubuntu-latest

strategy:
matrix:
node_version: [12]

steps:
- uses: actions/checkout@v2.1.1

- uses: actions/setup-node@v2
with:
node-version: '${{ matrix.node_version }}'

- name: Install
run: |
yarn --ignore-engines
- name: Build
run: |
yarn docker-boot
yarn build-emscripten
- name: Tests
run: |
yarn lint
yarn test-fast
yarn check-prettier
yarn check-docs
yarn check-tsd
yarn cover
- uses: coverallsapp/github-action@master
with:
path-to-lcov: ./coverage/lcov.info
github-token: ${{ secrets.GITHUB_TOKEN }}
54 changes: 0 additions & 54 deletions .travis.yml

This file was deleted.

10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
<!-- the README is generated from a template, please edit doc-files/README.md.tmpl -->

<img align="right" src="https://uber.github.io/img/h3Logo-color.svg" alt="H3 Logo" width="200">

# h3-js

[![H3 Version](https://img.shields.io/badge/h3_api-v3.7.1-blue.svg)](https://github.com/uber/h3/releases/tag/v3.7.1) [![Build Status](https://travis-ci.com/uber/h3-js.svg?branch=master)](https://travis-ci.com/uber/h3-js) [![Coverage Status](https://coveralls.io/repos/github/uber/h3-js/badge.svg?branch=master)](https://coveralls.io/github/uber/h3-js?branch=master)
[![Build Status](https://github.com/uber/h3-js/workflows/test/badge.svg)](https://github.com/uber/h3-js/actions)
[![Coverage Status](https://coveralls.io/repos/github/uber/h3-js/badge.svg?branch=master)](https://coveralls.io/github/uber/h3-js?branch=master)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
[![npm version](https://badge.fury.io/js/h3-js.svg)](https://badge.fury.io/js/h3-js)
[![H3 Version](https://img.shields.io/badge/h3_api-v3.7.1-blue.svg)](https://github.com/uber/h3/releases/tag/v3.7.1)

The `h3-js` library provides a pure-JavaScript version of the [H3 Core Library](https://github.com/uber/h3), a hexagon-based geographic grid system. It can be used either in Node >= 6 or in the browser. The core library is transpiled from C using [emscripten](http://kripken.github.io/emscripten-site), offering full parity with the C API and highly efficient operations.

For more information on H3 and for the full API documentation, please see the [H3 Documentation](https://uber.github.io/h3/).
For more information on H3 and for the full API documentation, please see the [H3 Documentation](https://h3geo.org).

- Post **bug reports or feature requests** to the [Github Issues page](https://github.com/uber/h3-js/issues)
- Ask **questions** by posting to the [H3 tag on StackOverflow](https://stackoverflow.com/questions/tagged/h3)
Expand Down
10 changes: 8 additions & 2 deletions doc-files/README.tmpl.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
<!-- the README is generated from a template, please edit doc-files/README.md.tmpl -->

<img align="right" src="https://uber.github.io/img/h3Logo-color.svg" alt="H3 Logo" width="200">

# h3-js

[![H3 Version](https://img.shields.io/badge/h3_api-v{{h3Version}}-blue.svg)](https://github.com/uber/h3/releases/tag/v{{h3Version}}) [![Build Status](https://travis-ci.com/uber/h3-js.svg?branch=master)](https://travis-ci.com/uber/h3-js) [![Coverage Status](https://coveralls.io/repos/github/uber/h3-js/badge.svg?branch=master)](https://coveralls.io/github/uber/h3-js?branch=master)
[![Build Status](https://github.com/uber/h3-js/workflows/test/badge.svg)](https://github.com/uber/h3-js/actions)
[![Coverage Status](https://coveralls.io/repos/github/uber/h3-js/badge.svg?branch=master)](https://coveralls.io/github/uber/h3-js?branch=master)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
[![npm version](https://badge.fury.io/js/h3-js.svg)](https://badge.fury.io/js/h3-js)
[![H3 Version](https://img.shields.io/badge/h3_api-v3.7.1-blue.svg)](https://github.com/uber/h3/releases/tag/v3.7.1)

The `h3-js` library provides a pure-JavaScript version of the [H3 Core Library](https://github.com/uber/h3), a hexagon-based geographic grid system. It can be used either in Node >= 6 or in the browser. The core library is transpiled from C using [emscripten](http://kripken.github.io/emscripten-site), offering full parity with the C API and highly efficient operations.

For more information on H3 and for the full API documentation, please see the [H3 Documentation](https://uber.github.io/h3/).
For more information on H3 and for the full API documentation, please see the [H3 Documentation](https://h3geo.org).

- Post **bug reports or feature requests** to the [Github Issues page](https://github.com/uber/h3-js/issues)
- Ask **questions** by posting to the [H3 tag on StackOverflow](https://stackoverflow.com/questions/tagged/h3)
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
"docker-boot": "docker run -dit --name emscripten -v $(pwd):/src trzeci/emscripten:sdk-tag-1.38.43-64bit bash",
"docker-reboot": "docker stop emscripten && docker rm emscripten && yarn docker-boot",
"docker-emscripten": "yarn docker-emscripten-umd",
"docker-emscripten-run": "yarn rollup-bindings && docker exec -it emscripten bash scripts/update-emscripten.sh",
"docker-emscripten-run": "yarn rollup-bindings && docker exec emscripten bash scripts/update-emscripten.sh",
"docker-emscripten-umd": "yarn docker-emscripten-run -o libh3.js",
"docker-emscripten-browser": "yarn docker-emscripten-run -s ENVIRONMENT=web -o libh3-browser.js && mv out/libh3-browser.js dist",
"check-prettier": "yarn prettier && git diff --exit-code",
Expand All @@ -54,7 +54,7 @@
"test": "yarn lint && yarn test-fast",
"test-fast": "yarn test-raw | faucet",
"test-raw": "yarn rollup-test && node dist/test.js",
"cover": "yarn rollup-test && nyc --clean node dist/test.js",
"cover": "yarn rollup-test && nyc --clean --reporter=lcov --reporter=text node dist/test.js",
"cover-view": "yarn rollup-test && nyc --clean --reporter=html node dist/test.js && open coverage/index.html",
"benchmark-node": "yarn rollup-benchmark-node && node dist/benchmark.node.js",
"benchmark-browser": "yarn rollup-benchmark-browser && budo dist/benchmark.browser.js --open --title 'h3-js benchmarks'",
Expand Down

0 comments on commit 3e091ef

Please sign in to comment.