Prepare for release

snowplow · Sep 4, 2020 · 44be0ea · 44be0ea
1 parent 1f3a4a8
commit 44be0ea
Show file tree

Hide file tree

Showing 12 changed files with 63 additions and 28 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,22 @@
+Version 0.4.0 (2020-09-04)
+--------------------------
+Switch from 'request' to 'got' (#61)
+Remove Vagrant image (#56)
+Add Snyk support (#60)
+Switch to GitHub Actions (#54)
+Add setNetworkUserId method (#23)
+Add setDomainUserId method (#24)
+Add support for dvce_sent_tstamp (#27)
+Bump snowplow-tracker-core to 0.9.1 (#58)
+Switch out Mocha for Ava (#59)
+Add Typescript support (#13)
+Bump NodeJS to support active LTS releases (#55)
+Switch to RollupJS for building ES Module and CJS versions (#57)
+Update project dependencies (#49)
+Update flush to not send a request if the buffer is empty (#53)
+Add Snowplow Maintenance Badge (#47)
+Add CONTRIBUTING.md (#46)
+
 Version 0.3.0 (2017-04-28)
 --------------------------
 Add npm credentials to .travis.yml (#36)

diff --git a/README.md b/README.md
@@ -1,22 +1,22 @@
 # Node.js Analytics for Snowplow
 
 [![early-release]][tracker-classificiation]
-[![Build Status][travis-image]][travis]
+[![Build Status][gh-actions-image]][gh-actions]
 [![npm version][npm-image]][npm-url]
 [![Coveralls][coveralls-image]][coveralls]
 
 ## Overview
 
-Add analytics to your JavaScript apps, node-webkit projects and Node.js servers with the [Snowplow][snowplow] Node.js Tracker.
+Add analytics to your JavaScript and TypeScript Node.js applications and servers with the Snowplow Node.js Tracker.
 
 This tracker lets you collect event data from Node.js applications.
 
 ## Find out more
 
-| Technical Docs                       | Setup Guide                   | Roadmap & Contributing  |
-|--------------------------------------|-------------------------------|-------------------------|
-| [![i1][techdocs-image]][tech-docs] | [![i2][setup-image]][setup] | ![i3][roadmap-image]    |
-| [Technical Docs][tech-docs]          | [Setup Guide][setup]          | _coming soon_           |
+| Technical Docs                       | Setup Guide                   | Contributing                    |
+|--------------------------------------|-------------------------------|---------------------------------|
+| [![i1][techdocs-image]][tech-docs]   | [![i2][setup-image]][setup]   | ![i3][contributing-image]       |
+| [Technical Docs][tech-docs]          | [Setup Guide][setup]          | [Contributing](Contributing.md) |
 
 ## Developers
 
@@ -30,12 +30,13 @@ Install npm dependencies using `npm install`:
 git clone [email protected]:snowplow/snowplow-nodejs-tracker.git
 cd snowplow-nodejs-tracker
 npm install
+npm run build
 npm test
 ```
 
 ## Copyright and license
 
-The Snowplow Node.js Tracker is copyright 2014-2017 Snowplow Analytics Ltd.
+The Snowplow Node.js Tracker is copyright 2014-2020 Snowplow Analytics Ltd.
 
 Licensed under the **[Apache License, Version 2.0][license]** (the "License");
 you may not use this software except in compliance with the License.
@@ -50,18 +51,18 @@ limitations under the License.
 
 [license]: http://www.apache.org/licenses/LICENSE-2.0
 
-[travis-image]: https://travis-ci.org/snowplow/snowplow-nodejs-tracker.png?branch=master
-[travis]: https://travis-ci.org/snowplow/snowplow-nodejs-tracker
+[gh-actions]: https://github.com/snowplow/snowplow-nodejs-tracker/actions
+[gh-actions-image]: https://github.com/snowplow/snowplow-nodejs-tracker/workflows/Build/badge.svg
 [npm-url]: https://badge.fury.io/js/snowplow-tracker
 [npm-image]: https://badge.fury.io/js/snowplow-tracker.svg
-[coveralls-image]: https://coveralls.io/repos/snowplow/snowplow-nodejs-tracker/badge.png?branch=master
-[coveralls]: https://coveralls.io/r/snowplow/snowplow-nodejs-tracker?branch=master
+[coveralls-image]: https://coveralls.io/repos/github/snowplow/snowplow-nodejs-tracker/badge.svg?branch=master
+[coveralls]: https://coveralls.io/github/snowplow/snowplow-nodejs-tracker?branch=master
 
-[tech-docs]: https://github.com/snowplow/snowplow/wiki/node.js-tracker
+[tech-docs]: https://docs.snowplowanalytics.com/docs/collecting-data/collecting-from-own-applications/node-js-tracker/configuration/
 [techdocs-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/techdocs.png
-[setup]: https://github.com/snowplow/snowplow/wiki/node.js-tracker-setup
+[setup]: https://docs.snowplowanalytics.com/docs/collecting-data/collecting-from-own-applications/node-js-tracker/setup/
 [setup-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/setup.png
-[roadmap-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/roadmap.png
+[contributing-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/contributing.png
 
 [tracker-classificiation]: https://github.com/snowplow/snowplow/wiki/Tracker-Maintenance-Classification
 [early-release]: https://img.shields.io/static/v1?style=flat&label=Snowplow&message=Early%20Release&color=014477&labelColor=9ba0aa&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAAeFBMVEVMaXGXANeYANeXANZbAJmXANeUANSQAM+XANeMAMpaAJhZAJeZANiXANaXANaOAM2WANVnAKWXANZ9ALtmAKVaAJmXANZaAJlXAJZdAJxaAJlZAJdbAJlbAJmQAM+UANKZANhhAJ+EAL+BAL9oAKZnAKVjAKF1ALNBd8J1AAAAKHRSTlMAa1hWXyteBTQJIEwRgUh2JjJon21wcBgNfmc+JlOBQjwezWF2l5dXzkW3/wAAAHpJREFUeNokhQOCA1EAxTL85hi7dXv/E5YPCYBq5DeN4pcqV1XbtW/xTVMIMAZE0cBHEaZhBmIQwCFofeprPUHqjmD/+7peztd62dWQRkvrQayXkn01f/gWp2CrxfjY7rcZ5V7DEMDQgmEozFpZqLUYDsNwOqbnMLwPAJEwCopZxKttAAAAAElFTkSuQmCC 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "snowplow-tracker",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/esm/index.d.ts",

diff --git a/src/emitter.ts b/src/emitter.ts
@@ -1,3 +1,18 @@
+/*
+ * Node.js tracker for Snowplow: emitter.ts
+ *
+ * Copyright (c) 2014-2020 Snowplow Analytics Ltd. All rights reserved.
+ *
+ * This program is licensed to you under the Apache License Version 2.0,
+ * and you may not use this file except in compliance with the Apache License Version 2.0.
+ * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the Apache License Version 2.0 is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
+ */
+
 import { PayloadDictionary } from 'snowplow-tracker-core';
 
 export interface Emitter {

diff --git a/src/got_emitter.ts b/src/got_emitter.ts
@@ -1,7 +1,7 @@
 /*
- * Node.js tracker for Snowplow: emitter.js
+ * Node.js tracker for Snowplow: got_emitter.ts
  *
- * Copyright (c) 2014-2017 Snowplow Analytics Ltd. All rights reserved.
+ * Copyright (c) 2014-2020 Snowplow Analytics Ltd. All rights reserved.
  *
  * This program is licensed to you under the Apache License Version 2.0,
  * and you may not use this file except in compliance with the Apache License Version 2.0.

diff --git a/src/index.ts b/src/index.ts
@@ -1,7 +1,7 @@
 /*
- * Node.js tracker for Snowplow: index.js
+ * Node.js tracker for Snowplow: index.ts
  *
- * Copyright (c) 2014-2015 Snowplow Analytics Ltd. All rights reserved.
+ * Copyright (c) 2014-2020 Snowplow Analytics Ltd. All rights reserved.
  *
  * This program is licensed to you under the Apache License Version 2.0,
  * and you may not use this file except in compliance with the Apache License Version 2.0.

diff --git a/src/tracker.ts b/src/tracker.ts
@@ -1,7 +1,7 @@
 /*
- * Node.js tracker for Snowplow: tracker.js
+ * Node.js tracker for Snowplow: tracker.ts
  *
- * Copyright (c) 2014-2015 Snowplow Analytics Ltd. All rights reserved.
+ * Copyright (c) 2014-2020 Snowplow Analytics Ltd. All rights reserved.
  *
  * This program is licensed to you under the Apache License Version 2.0,
  * and you may not use this file except in compliance with the Apache License Version 2.0.

diff --git a/src/version.ts b/src/version.ts
@@ -1,7 +1,7 @@
 /*
- * Node.js tracker for Snowplow: version.js
+ * Node.js tracker for Snowplow: version.ts
  *
- * Copyright (c) 2014-2017 Snowplow Analytics Ltd. All rights reserved.
+ * Copyright (c) 2014-2020 Snowplow Analytics Ltd. All rights reserved.
  *
  * This program is licensed to you under the Apache License Version 2.0,
  * and you may not use this file except in compliance with the Apache License Version 2.0.
@@ -13,4 +13,4 @@
  * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
  */
 
-export const version = '0.3.0';
+export const version = '0.4.0';
diff --git a/test/emitter.ts b/test/emitter.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2014-2015 Snowplow Analytics Ltd. All rights reserved.
+ * Copyright (c) 2014-2020 Snowplow Analytics Ltd. All rights reserved.
  *
  * This program is licensed to you under the Apache License Version 2.0,
  * and you may not use this file except in compliance with the Apache License Version 2.0.

diff --git a/test/got_emitter.ts b/test/got_emitter.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2014-2015 Snowplow Analytics Ltd. All rights reserved.
+ * Copyright (c) 2014-2020 Snowplow Analytics Ltd. All rights reserved.
  *
  * This program is licensed to you under the Apache License Version 2.0,
  * and you may not use this file except in compliance with the Apache License Version 2.0.

diff --git a/test/tracker.ts b/test/tracker.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2014-2015 Snowplow Analytics Ltd. All rights reserved.
+ * Copyright (c) 2014-2020 Snowplow Analytics Ltd. All rights reserved.
  *
  * This program is licensed to you under the Apache License Version 2.0,
  * and you may not use this file except in compliance with the Apache License Version 2.0.