reg-notify-github-with-api-plugin

Notify reg-suit result to GHE repository using API

Usage no npm install needed!

<script type="module">
  import regNotifyGithubWithApiPlugin from 'https://cdn.skypack.dev/reg-notify-github-with-api-plugin';
</script>

README

reg-notify-github-with-api-plugin

reg-suit plugin to send notification the testing result to your GitHub repository.

It's similar to reg-notify-github-plugin. While reg-notify-github-plugin uses GitHub App, this plugin uses GitHub API with personal access token. We create this plugin for GitHub Enterprise user. reg-notify-github-plugin is strongly recommended if you use github.com.

Install

npm i reg-notify-github-with-api-plugin -D
reg-suit prepare -p notify-github-with-api

Configure

{
  githubUrl?: sring;
  owner: string;
  repository: string;
  privateToken: string;
  ref?: string;
  shortDescription?: boolean;
}

  • githubUrl - Optional - URL for your GitHub Enterprise. Default: https://api.github.com/graphql.

  • owner - Required - GitHub owner name.

  • repository - Required - GitHub repository name.

  • privateToken - Required Private access token. The repo scope is required if the repository is private.

  • ref - Optional Git branch ref value. If specified, this plugin searches PRs to comment using this value.

  • shortDescription - Optional Returns a small table with the item counts. Example:

    🔴 Changed ⚪️ New 🔵 Passing
    3 4 120