Skip to content

Commit 7cb28cf

Browse files
committed
Github Actions Support
1 parent 4972b56 commit 7cb28cf

File tree

4 files changed

+10380
-19
lines changed

4 files changed

+10380
-19
lines changed

.github/workflows/build.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Build
2+
on: [ push, pull_request ]
3+
4+
jobs:
5+
build:
6+
runs-on: ubuntu-latest
7+
steps:
8+
- name: Checkout
9+
uses: actions/checkout@v2
10+
with:
11+
fetch-depth: 0
12+
- name: Build Reason
13+
run: "echo ref: ${{github.ref}} event: ${{github.event_name}}"
14+
- name: Setup Node.js environment
15+
uses: actions/setup-node@v2.1.2
16+
- name: NPM install with caching
17+
uses: bahmutov/npm-install@v1.1.0
18+
- name: Build
19+
run: gulp build
20+
- name: Run Tests
21+
run: gulp test

.vscode/settings.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
// Place your settings in this file to overwrite default and user settings.
22
{
33
"files.insertFinalNewline": true,
4-
"typescript.tsdk": "./node_modules/typescript/lib"
4+
"typescript.tsdk": "./node_modules/typescript/lib",
5+
"cSpell.words": [
6+
"systemjs",
7+
"tracekit",
8+
"tsproject"
9+
]
510
}

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
# Exceptionless.JavaScript
2-
[![Build status](https://ci.appveyor.com/api/projects/status/ahu7u4tvls56wqqu/branch/master?svg=true)](https://ci.appveyor.com/project/Exceptionless/exceptionless-javascript)
2+
3+
[![Build status](https://github.com/Exceptionless/Exceptionless.JavaScript/workflows/Build/badge.svg)](https://github.com/Exceptionless/Exceptionless.JavaScript/actions)
34
[![Discord](https://img.shields.io/discord/715744504891703319)](https://discord.gg/6HxgFCx)
45
[![NPM version](https://img.shields.io/npm/v/exceptionless.svg)](https://www.npmjs.org/package/exceptionless)
56
[![Bower version](https://img.shields.io/bower/v/exceptionless.svg)](http://bower.io/search/?q=exceptionless)
67
[![Donate](https://img.shields.io/badge/donorbox-donate-blue.svg)](https://donorbox.org/exceptionless?recurring=true)
78

89
The definition of the word exceptionless is: to be without exception. Exceptionless.js provides real-time error reporting for your JavaScript applications in the browser or in Node.js. It organizes the gathered information into simple actionable data that will help your app become exceptionless!
910

10-
## Show me the code! ##
11+
## Show me the code!
1112

1213
```html
1314
<script src="https://cdn.rawgit.com/exceptionless/Exceptionless.JavaScript/v1.6.3/dist/exceptionless.min.js"></script>
@@ -42,6 +43,7 @@ try {
4243
You can install Exceptionless.js either in your browser application using Bower or a `script` tag, or you can use the Node Package Manager (npm) to install the Node.js package.
4344

4445
#### Browser application
46+
4547
Use one of the following methods to install Exceptionless.js into your browser application:
4648

4749
- **CDN:**
@@ -64,6 +66,7 @@ Use one of the following methods to install Exceptionless.js into your browser a
6466
In either case, we recommend placing the `script` tag at the very beginning of your page.
6567

6668
#### Node.js
69+
6770
Use this method to install Exceptionless.js into your Node application:
6871

6972
1. Install the package by running `npm install exceptionless --save`.
@@ -74,10 +77,12 @@ Use this method to install Exceptionless.js into your Node application:
7477
```
7578

7679
### Configuring the client
80+
7781
In order to use Exceptionless.js, the `apiKey` setting has to be configured first.
7882
You can configure the `ExceptionlessClient` class using one of the following ways:
7983

8084
#### Browser application
85+
8186
- You can configure the `apiKey` as part of the script tag. This will be applied to all new instances of the `ExceptionlessClient` class:
8287

8388
```html
@@ -105,6 +110,7 @@ You can configure the `ExceptionlessClient` class using one of the following way
105110
```
106111

107112
#### Node.js
113+
108114
- You can set the `apiKey` on the default `ExceptionlessClient` instance:
109115

110116
```javascript
@@ -129,6 +135,7 @@ You can configure the `ExceptionlessClient` class using one of the following way
129135
```
130136

131137
### Submitting Events and Errors
138+
132139
Once configured, Exceptionless.js will automatically submit any unhandled exceptions that happen in your application to the Exceptionless server. The following sections will show you how to manually submit different event types as well as customize the data that is sent:
133140

134141
#### Submitting Events
@@ -159,6 +166,7 @@ client.createNotFound('/somepage').addTags('Exceptionless').submit();
159166
// Submit a custom event type
160167
client.submitEvent({ message = 'Low Fuel', type = 'racecar', source = 'Fuel System' });
161168
```
169+
162170
#### Manually submitting Errors
163171

164172
In addition to automatically sending all unhandled exceptions, you may want to manually send exceptions to the service. You can do so by using code like this:
@@ -215,13 +223,15 @@ try {
215223
The Exceptionless client can also be configured to send data to your self hosted instance. This is configured by setting the `serverUrl` setting to point to your Exceptionless instance:
216224

217225
#### Browser
226+
218227
You can set the `serverUrl` on the default `ExceptionlessClient` instance:
219228

220229
```javascript
221230
exceptionless.ExceptionlessClient.default.config.serverUrl = 'http://localhost:50000';
222231
```
223232

224233
#### Node.js
234+
225235
You can set the `serverUrl` on the default `ExceptionlessClient` instance:
226236

227237
```javascript
@@ -230,6 +240,7 @@ client.config.serverUrl = 'http://localhost:50000';
230240
```
231241

232242
### General Data Protection Regulation
243+
233244
By default the Exceptionless Client will report all available metadata including potential PII data.
234245
You can fine tune the collection of information via Data Exclusions or turning off collection completely.
235246

@@ -249,7 +260,6 @@ If you find a bug or want to contribute a feature, feel free to create a pull re
249260
```sh
250261
git clone https://github.com/exceptionless/Exceptionless.JavaScript.git
251262
```
252-
253263
2. Install [Node.js](https://nodejs.org). Node is used for building and testing purposes.
254264

255265
3. Install [tsd](https://github.com/DefinitelyTyped/tsd) and [gulp](http://gulpjs.com) and the development dependencies using [npm](https://www.npmjs.com).

0 commit comments

Comments
 (0)