sentry-files

Zero-dependency Node library to upload source maps to Sentry

Installation

``bash
yarn add sentry-files --dev
`

Usage

`js
import path from 'path';
const { upload } = require('sentry-files');

const config = {
version: '1.0.0',
organization: 'example-organization',
project: 'example-project',
token: 'YOUR_API_TOKEN_HERE',
files: [
{
name: 'http://example.com/assets/main.js.map',
path: path.resolve(__dirname, 'path/to/main.js.map'),
},
],
};

upload(config)
.then(data => console.log('----- SUCCESS ----\n', data))
.catch(error => console.log('---- ERROR ----\n', error));
`

For an example uploading source maps of a React app check this post.

API

$3

Type: function\
Returns: Promise

It creates a release and uploads the files to that release.

$3

Type: Object\
_Required_

An object specifying the options used to create the release and upload the files.

$3

Type: String\
_Required_

Version used to create the release.

$3

Type: String\
_Required_

Sentry organization name.

$3

Type: String\
_Required_

Sentry project name.

$3

Type: String\
_Required_

Authentication token required to perform actions against the Sentry API.

_Ensure you have project:write selected under scopes._

$3

Type: Array\
_Required_

Array of objects describing the files to upload to Sentry.

`js
[
{
name: 'Sentry file name',
path: 'Local file path'
},
{
name: '...',
path: '...'
}
…]
`

$3

Type: String\
_Required_

Name of the file on Sentry.

_More about Sentry file names: Upload a New File, Uploading Source Maps to Sentry and Assets Accessible at Multiple Origins_

$3

Type: String`\
_Required_

Path to the file locally.

License

#### MIT