meta: Prepare major release (#1538)

Author: HazAT

CHANGELOG.md

@@ -0,0 +1,127 @@
+# Changelog
+
+## 4.0.0
+
+This is the release of our new SDKs, `@sentry/browser`, `@sentry/node`. While there are too many changes to list for
+this release, we will keep a consistent changelog for upcoming new releases. `raven-js` (our legacy JavaScript/Browser
+SDK) and `raven` (our legacy Node.js SDK) will still reside in this repo, but they will receive their own changelog.
+
+We generally guide people to use our new SDKs from this point onward. The migration should be straightforward if you
+were only using the basic features of our previous SDKs.
+
+`raven-js` and `raven` will both still receive bugfixes but all the new features implemented will only work in the new
+SDKs. The new SDKs are completely written in TypeScript, which means all functions, classes and properties are typed.
+
+## Links
+
+- [Official SDK Docs](https://docs.sentry.io/quickstart/)
+- [TypeDoc](http://getsentry.github.io/sentry-javascript/)
+
+### Migration
+
+Here are some examples of how the new SDKs work. Please note that the API for all JavaScript SDKs is the same.
+
+#### Installation
+
+_Old_:
+
+```js
+Raven.config('___PUBLIC_DSN___', {
+  release: '1.3.0',
+}).install();
+```
+
+_New_:
+
+```js
+Sentry.init({
+  dsn: '___PUBLIC_DSN___',
+  release: '1.3.0',
+});
+```
+
+#### Set a global tag
+
+_Old_:
+
+```js
+Raven.setTagsContext({ key: 'value' });
+```
+
+_New_:
+
+```js
+Sentry.configureScope(scope => {
+  scope.setTag('key', 'value');
+});
+```
+
+#### Capture custom exception
+
+_Old_:
+
+```js
+try {
+  throwingFunction();
+} catch (e) {
+  Raven.captureException(e, { extra: { debug: false } });
+}
+```
+
+_New_:
+
+```js
+try {
+  throwingFunction();
+} catch (e) {
+  Sentry.withScope(scope => {
+    scope.setExtra('debug', false);
+    Sentry.captureException(e);
+  });
+}
+```
+
+#### Capture a message
+
+_Old_:
+
+```js
+Raven.captureMessage('test', 'info', { extra: { debug: false } });
+```
+
+_New_:
+
+```js
+Sentry.withScope(scope => {
+  scope.setExtra('debug', false);
+  Sentry.captureMessage('test', 'info');
+});
+```
+
+#### Breadcrumbs
+
+_Old_:
+
+```js
+Raven.captureBreadcrumb({
+  message: 'Item added to shopping cart',
+  category: 'action',
+  data: {
+    isbn: '978-1617290541',
+    cartSize: '3',
+  },
+});
+```
+
+_New_:
+
+```js
+Sentry.addBreadcrumb({
+  message: 'Item added to shopping cart',
+  category: 'action',
+  data: {
+    isbn: '978-1617290541',
+    cartSize: '3',
+  },
+});
+```

Makefile

@@ -20,4 +20,14 @@ publish:
 publish-cdn:
 	node scripts/browser-upload-cdn.js
 
+publish-docs:
+	node ./node_modules/.bin/typedoc --options ./typedoc.js
+	rm -rf /tmp/sentry-js-docs | true
+	cp -r ./docs /tmp/sentry-js-docs
+	git checkout gh-pages
+	cp -r /tmp/sentry-js-docs/* .
+	git commit -a -m "meta: Update docs"
+	git push origin gh-pages
+	git checkout master
+
 release: bump prepare-release publish publish-cdn

README.md

@@ -8,14 +8,17 @@
 [![Build Status](https://travis-ci.com/getsentry/sentry-javascript.svg?branch=master)](https://travis-ci.com/getsentry/sentry-javascript)
 [![codecov](https://codecov.io/gh/getsentry/sentry-javascript/branch/master/graph/badge.svg)](https://codecov.io/gh/getsentry/sentry-javascript)
 [![npm version](https://img.shields.io/npm/v/@sentry/core.svg)](https://www.npmjs.com/package/@sentry/core)
+[![typedoc](https://img.shields.io/badge/docs-typedoc-blue.svg)](http://getsentry.github.io/sentry-javascript/)
 
 # Official Sentry SDKs for JavaScript
 
 This is the next line of Sentry JavaScript SDKs, comprised in the `@sentry/` namespace. It will provide a more
 convenient interface and improved consistency between various JavaScript environments.
 
-**WARNING:** All of these SDKs are still undergoing active development, so the public interface might change and break
-backwards compatibility from time to time.
+## Links
+
+- [Official SDK Docs](https://docs.sentry.io/quickstart/)
+- [TypeDoc](http://getsentry.github.io/sentry-javascript/)
 
 ## Contents
 
@@ -30,21 +33,22 @@ backwards compatibility from time to time.
 For each major JavaScript platform, there is a specific high-level SDK that provides all the tools you need in a single
 package. Please refer to the README and instructions of those SDKs for more detailed information:
 
-- [`@sentry/hub`](https://github.com/getsentry/raven-js/tree/master/packages/hub): Global state management of SDKs
-- [`@sentry/minimal`](https://github.com/getsentry/raven-js/tree/master/packages/minimal): Minimal SDK for library
-  authors to add Sentry support
-- [`@sentry/browser`](https://github.com/getsentry/raven-js/tree/master/packages/browser): SDK for Browsers, including
-  integrations for React, Angular, Ember, Vue and Backbone
-- [`@sentry/node`](https://github.com/getsentry/raven-js/tree/master/packages/node): SDK for Node, including
+- [`@sentry/hub`](https://github.com/getsentry/sentry-javascript/tree/master/packages/hub): Global state management of
+  SDKs
+- [`@sentry/minimal`](https://github.com/getsentry/sentry-javascript/tree/master/packages/minimal): Minimal SDK for
+  library authors to add Sentry support
+- [`@sentry/browser`](https://github.com/getsentry/sentry-javascript/tree/master/packages/browser): SDK for Browsers,
+  including integrations for React, Angular, Ember, Vue and Backbone
+- [`@sentry/node`](https://github.com/getsentry/sentry-javascript/tree/master/packages/node): SDK for Node, including
   integrations for Express, Koa, Loopback, Sails and Connect
 - [`@sentry/electron`](https://github.com/getsentry/sentry-electron): SDK for Electron with support for native crashes
 - [`sentry-cordova`](https://github.com/getsentry/sentry-cordova): SDK for Cordova Apps and Ionic with support for
   native crashes
-- [`raven-js`](https://github.com/getsentry/raven-js/tree/master/packages/raven-js): Our old stable Javascript SDK, we
-  still support and release bug fixes for the SDK but all new features will be implemented in `@sentry/browser` which is
-  the successor.
-- [`raven`](https://github.com/getsentry/raven-js/tree/master/packages/raven-node): Our old stable Node SDK, same as for
-  `raven-js` we still support and release bug fixes for the SDK but all new features will be implemented in
+- [`raven-js`](https://github.com/getsentry/sentry-javascript/tree/master/packages/raven-js): Our old stable Javascript
+  SDK, we still support and release bug fixes for the SDK but all new features will be implemented in `@sentry/browser`
+  which is the successor.
+- [`raven`](https://github.com/getsentry/sentry-javascript/tree/master/packages/raven-node): Our old stable Node SDK,
+  same as for `raven-js` we still support and release bug fixes for the SDK but all new features will be implemented in
   `@sentry/node` which is the successor.
 
 ## Installation and Usage
@@ -75,15 +79,11 @@ Besides the high-level SDKs, this repository contains shared packages, helpers a
 development. If you're thinking about contributing to or creating a JavaScript-based SDK, have a look at the resources
 below:
 
-- [`@sentry/core`](https://github.com/getsentry/raven-js/tree/master/packages/core): The base for all JavaScript SDKs
-  with interfaces, type definitions and base classes.
-- [`@sentry/utils`](https://github.com/getsentry/raven-js/tree/master/packages/utils): A set of helpers and utility
-  functions useful for various SDKs.
-- [`@sentry/typescript`](https://github.com/getsentry/raven-js/tree/master/packages/typescript): Shared Typescript
-  compiler and linter options.
-- [`@sentry/types`](https://github.com/getsentry/raven-js/tree/master/packages/types): Types used in all packages.
-
-## Join the Discussion
-
-Join the discussion in our [tracking issue](https://github.com/getsentry/raven-js/issues/1281) and let us know what you
-think of the updated interface and new possibilities.
+- [`@sentry/core`](https://github.com/getsentry/sentry-javascript/tree/master/packages/core): The base for all
+  JavaScript SDKs with interfaces, type definitions and base classes.
+- [`@sentry/utils`](https://github.com/getsentry/sentry-javascript/tree/master/packages/utils): A set of helpers and
+  utility functions useful for various SDKs.
+- [`@sentry/typescript`](https://github.com/getsentry/sentry-javascript/tree/master/packages/typescript): Shared
+  Typescript compiler and linter options.
+- [`@sentry/types`](https://github.com/getsentry/sentry-javascript/tree/master/packages/types): Types used in all
+  packages.

lerna.json

@@ -1,5 +1,5 @@
 {
-  "lerna": "2.11.0",
+  "lerna": "3.4.0",
   "version": "4.0.0-rc.2",
   "packages": "packages/*",
   "ignore": "raven-*",

package.json

@@ -31,7 +31,7 @@
     "codecov": "^3.0.2",
     "jest": "^22.4.3",
     "karma-sinon": "^1.0.5",
-    "lerna": "3.0.0-beta.20",
+    "lerna": "3.4.0",
     "mocha": "^5.1.1",
     "npm-run-all": "^4.1.2",
     "prettier": "^1.14.0",

packages/browser/README.md

@@ -10,6 +10,12 @@
 [![npm version](https://img.shields.io/npm/v/@sentry/browser.svg)](https://www.npmjs.com/package/@sentry/browser)
 [![npm dm](https://img.shields.io/npm/dm/@sentry/browser.svg)](https://www.npmjs.com/package/@sentry/browser)
 [![npm dt](https://img.shields.io/npm/dt/@sentry/browser.svg)](https://www.npmjs.com/package/@sentry/browser)
+[![typedoc](https://img.shields.io/badge/docs-typedoc-blue.svg)](http://getsentry.github.io/sentry-javascript/)
+
+## Links
+
+- [Official SDK Docs](https://docs.sentry.io/quickstart/)
+- [TypeDoc](http://getsentry.github.io/sentry-javascript/)
 
 ## Usage
 

packages/core/README.md

@@ -10,6 +10,14 @@
 [![npm version](https://img.shields.io/npm/v/@sentry/core.svg)](https://www.npmjs.com/package/@sentry/core)
 [![npm dm](https://img.shields.io/npm/dm/@sentry/core.svg)](https://www.npmjs.com/package/@sentry/core)
 [![npm dt](https://img.shields.io/npm/dt/@sentry/core.svg)](https://www.npmjs.com/package/@sentry/core)
+[![typedoc](https://img.shields.io/badge/docs-typedoc-blue.svg)](http://getsentry.github.io/sentry-javascript/)
+
+## Links
+
+- [Official SDK Docs](https://docs.sentry.io/quickstart/)
+- [TypeDoc](http://getsentry.github.io/sentry-javascript/)
+
+## General
 
 This package contains interface definitions, base classes and utilities for building Sentry JavaScript SDKs, like
 `@sentry/node` or `@sentry/browser`.

packages/hub/README.md

@@ -10,3 +10,13 @@
 [![npm version](https://img.shields.io/npm/v/@sentry/hub.svg)](https://www.npmjs.com/package/@sentry/hub)
 [![npm dm](https://img.shields.io/npm/dm/@sentry/hub.svg)](https://www.npmjs.com/package/@sentry/hub)
 [![npm dt](https://img.shields.io/npm/dt/@sentry/hub.svg)](https://www.npmjs.com/package/@sentry/hub)
+[![typedoc](https://img.shields.io/badge/docs-typedoc-blue.svg)](http://getsentry.github.io/sentry-javascript/)
+
+## Links
+
+- [Official SDK Docs](https://docs.sentry.io/quickstart/)
+- [TypeDoc](http://getsentry.github.io/sentry-javascript/)
+
+## General
+
+This package provides the `Hub` and `Scope` for all JavaScript related SDKs.

packages/minimal/README.md

@@ -10,6 +10,14 @@
 [![npm version](https://img.shields.io/npm/v/@sentry/minimal.svg)](https://www.npmjs.com/package/@sentry/minimal)
 [![npm dm](https://img.shields.io/npm/dm/@sentry/minimal.svg)](https://www.npmjs.com/package/@sentry/minimal)
 [![npm dt](https://img.shields.io/npm/dt/@sentry/minimal.svg)](https://www.npmjs.com/package/@sentry/minimal)
+[![typedoc](https://img.shields.io/badge/docs-typedoc-blue.svg)](http://getsentry.github.io/sentry-javascript/)
+
+## Links
+
+- [Official SDK Docs](https://docs.sentry.io/quickstart/)
+- [TypeDoc](http://getsentry.github.io/sentry-javascript/)
+
+## General
 
 A minimal Sentry SDK that uses a configured client when embedded into an application. It allows library authors add
 support for a Sentry SDK without having to bundle the entire SDK or being dependent on a specific platform. If the user

packages/node/README.md

@@ -10,6 +10,12 @@
 [![npm version](https://img.shields.io/npm/v/@sentry/node.svg)](https://www.npmjs.com/package/@sentry/node)
 [![npm dm](https://img.shields.io/npm/dm/@sentry/node.svg)](https://www.npmjs.com/package/@sentry/node)
 [![npm dt](https://img.shields.io/npm/dt/@sentry/node.svg)](https://www.npmjs.com/package/@sentry/node)
+[![typedoc](https://img.shields.io/badge/docs-typedoc-blue.svg)](http://getsentry.github.io/sentry-javascript/)
+
+## Links
+
+- [Official SDK Docs](https://docs.sentry.io/quickstart/)
+- [TypeDoc](http://getsentry.github.io/sentry-javascript/)
 
 ## Usage