README.md

git-bug-trace

Powerful bug profiling and tracking library. Automatically creates github issues

git-bug-trace is a simple library integrated with GitHub. It collects fatal errors caught on catch blocks at runtime and creates issues automatically to respective application repository

---

Install

$ npm install git-bug-trace -g

or

$ yarn add git-bug-trace

Usage

Keep track of bugs that are encountered on runtime in almond production services.

Getting started

// create a .env file with the following constants

let GIT_HUB_ACCESS_TOKEN,
  APPLICATION_NAME,
  OWNER,
  GIT_HUB_REPOSITORY,
  GIT_HUB_URL;

OWNER = "<Repository Owner>";
GIT_HUB_REPOSITORY = "<Your Repository>";
GIT_HUB_URL = "<Git Hub API base Url>";
GIT_HUB_ACCESS_TOKEN = "<token XXXXXXXXXXXXXXXXXXXXXXXXXXXX>";
APPLICATION_NAME = "<your application name>";

// init before usage
const almond = require("git-bug-trace");

// install and require .env configuration to enable you load theenvironment variables
require("dotenv").config();

Module

This Module exposes the following functions which are helper functions to enable issues to be logged automatically to github

module.exports = {
  gitHubEndpoints,
  gitHubCreateIssue,
  issueBody,
  issueHeading,
  gitHubGetIssues,
};

examples

Creating GitHubIssues

almond.gitHubCreateIssue(almond.issueHeading(almond.getCallerFile()),almond.issueBody('<Your Exception Message>','<Your Exception stack>'),<Configuration Object sample below >);

// Usage Example
const configs = {
  token: process.env.GIT_HUB_ACCESS_TOKEN,
  owner: process.env.OWNER,
  repository: process.env.GIT_HUB_REPOSITORY,
  appname: process.env.APPLICATION_NAME,
  base_url: process.env.GIT_HUB_URL,
};

// Get your allowed endpoints
const endpoints = almond.gitHubEndpoints(token);
endpoints.then((res) => {
  console.log(res.data);
});

// Create an issue from your runtime application
const issue = almond.gitHubCreateIssue(almond.issueHeading('GetUsers',configs.appname),almond.issueBody('Sample Exeption','application StackTrace'),configs);
issue.then((res) => {
  console.log(res.data);
});

Listing GitHubIssues

almond.gitHubGetIssues();

Listing GitHubEndpoints

almond.gitHubEndpoints();

LISENCE

Copyright © 2020

Almond Smart Farm. Licensed under the MIT license.

_ 🅰🅻🅼🅾🅽🅳 _