Skip to content

Technical/troubleshoot publish #10

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.

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
merged 2 commits into from
Oct 21, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Next Next commit
Remove npmrc
Add scope to publish workflow

Use exact [email protected] version in publish

Add scope to package.json name

Update repo location and package-lock name

Publish to npm registry

Publish with scoped package name

Publish scoped package to npm registry

Specify npm registry URL

Bump version with documentation changes

Add back .npmrc file
  • Loading branch information
aaronbloom committed Oct 21, 2020
commit bb188fb678bb6822e0e369f4e95f174fc501aa35
8 changes: 3 additions & 5 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,16 @@

root = true


[*]

# Change these settings to your own preference
indent_style = space
indent_size = 4

# We recommend you to keep these unchanged
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.yml]
indent_size = 2

[*.md]
trim_trailing_whitespace = false
9 changes: 5 additions & 4 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,15 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
- uses: actions/setup-node@v1.4.4
with:
node-version: 14
- run: npm install
- run: npm run build:gulp
- uses: actions/setup-node@v1
- uses: actions/setup-node@v1.4.4
with:
registry-url: 'https://npm.pkg.github.com'
registry-url: 'https://registry.npmjs.org'
scope: '@eclipsetrading'
- run: npm publish
env:
NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
69 changes: 6 additions & 63 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,15 @@
**fin-hypergrid** is an ultra-fast HTML5 grid presentation layer, achieving its speed by rendering (in a canvas tag) only the currently visible portion of your (virtual) grid, thus avoiding the latency and life-cycle issues of building, walking, and maintaining a complex DOM structure. Please be sure to checkout our [design overview](OVERVIEW.md)

Below is an example custom application built on top of the Hypergrid API tooling.
It also highlights a DOM-based custom external editor triggered via hypergrid events as well as interaction with Hypergrid’s column ordering API.

<img src="images/README/gridshot04.gif">

## Table of Contents
* [Current Release](#current-release)
* [Distribution](#distribution)
* [Demos](#demos)
* [Features](#features)
* [Testing](#testing)
* [Documentation](#developer-documentation)
* [Roadmap](#roadmap)
* [Contributing](#contributors)

**@eclipsetrading/hypergrid** is an ultra-fast HTML5 grid presentation layer, achieving its speed by rendering (in a canvas tag) only the currently visible portion of your (virtual) grid, thus avoiding the latency and life-cycle issues of building, walking, and maintaining a complex DOM structure. Please be sure to checkout our [design overview](OVERVIEW.md)
### Current Release

**v3.3.2**
25 November 2019
Forked as `eclipsetrading-hypergrid`. With the aim of converting to TypeScript and updating to use ES6 classes over `extend-me`.

**v4.0.0-alpha.1**
21 October 2020

### Distribution

#### npm module _(recommended)_
Published as a CommonJS module to [**npm**](http://npmjs.com/package/fin-hypergrid).
Published as a CommonJS module to [**npm**](http://npmjs.com/package/@eclipsetrading/hypergrid).
Specify a <a href="https://semver.org/">SEMVER</a> of `"fin-hypergrid": "3.3.2"` (or `"^3.3.2"`) in your package.json file,
issue the `npm install` command, and let your bundler (<a target="webpack" href="https://webpack.js.org/">wepback</a>,
<a target="browserify" href="http://browserify.org/">Browserify</a>) create a single file containing both Hypergrid and your application.
Expand All @@ -35,45 +21,6 @@ Your application can load one of these pre-bundled build files (in a `<script>`

As of v3.2.1, the same build files are also available in a `umd` folder on npm for distribution via the [**unpkg**](https://unpkg.com/) CDN which processes SEMVER semantics when provided. For example, `<script src="https://unpkg.com/fin-hypergrid@^3.2/umd/fin-hypergrid.min.js"></script>` loads v3.3.2 which is the greatest (most recent) version number matching the SEMVER pattern `^3.2` (aka 3.*.*).

### Demos

_The [`fin-hypergrid/build`](https://github.com/fin-hypergrid/build) repo generates the build files.
It also hosts the demo source files that test and show off various Hypergrid features.
Some of these use the npm module while others use the bundled build file.
Working versions of all demos are published to the CDN ([list of links](https://fin-hypergrid.github.io#demos))._

#### Testbench

The [default](https://fin-hypergrid.github.io/core) demo is the Hypergrid [dev testbench](https://fin-hypergrid.github.io/core/demo/index.html) ([source](https://github.com/fin-hypergrid/build/tree/master/testbench)).

(This app bundles the npm module plus all of its own modules together into a single file (`testbench.js`).
For illustrative purposes, [this alternate version](https://fin-hypergrid.github.io/core/demo/hypermods.html) loads
the pre-bundled build file `fin-hypergrid.js` plus specially IIFE-wrapped versions of each its own modules discretely.)

#### Simple example

See `example.html` for a very simple example ([repo](https://github.com/fin-hypergrid/build/blob/master/demo/example.html), [demo](https://fin-hypergrid.github.io/core/demo/example.html)):

![](images/README/simple.png)

#### Who else is using Hypergrid?

##### Perspective

The [Perspective](https://github.com/jpmorganchase/perspective) open source project uses Hypergrid v3 (demo links in the README) and does a lot more than Hypergrid alone, such as table pivots and charting.

![](images/README/perspective.png)

##### AdaptableBlotter.JS

[Openfin](http://openfin.co)’s AdaptableBlotter.JS ([installer](https://install.openfin.co/download/?fileName=adaptable_blotter_openfin&config=http://beta.adaptableblotter.com/app-beta.json)) is a demo app that shows the capabilities of both Openfin and Hypergrid.

![](images/README/partner-adaptableblotter_image-01@[email protected])

### Features

![](images/README/Hypergrid%20Features.png)

### Testing

Please use github [issues](https://github.com/fin-hypergrid/core/issues/new) to report problems
Expand All @@ -94,10 +41,6 @@ We also maintain versioned [online API documentation](https://fin-hypergrid.gith

Hypergrid global configurations can be found [here](https://fin-hypergrid.github.io/core/2.1.15/doc/module-defaults.html).

### Roadmap

For our current queue of upcoming work you can find it [here](ROADMAP.md)

### Contributors

Developers interested in contributing to this project should review our [contributing guide](CONTRIBUTING.md) before making pull requests.
20 changes: 0 additions & 20 deletions ROADMAP.md

This file was deleted.

4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"name": "hypergrid",
"version": "4.0.0-alpha.0",
"name": "@eclipsetrading/hypergrid",
"version": "4.0.0-alpha.1",
"description": "Canvas-based high-performance grid",
"main": "src/Hypergrid",
"repository": {
"type": "git",
"url": "git://github.com/EclipseTrading/hypergrid/core.git"
"url": "git://github.com/EclipseTrading/hypergrid.git"
},
"contributors": [
"Jonathan Eiten (https://github.com/joneit)",
Expand Down
1 change: 0 additions & 1 deletion version-history.md

This file was deleted.