github-xyz
Task wrapper that provides expressive CI feedback via GitHub checks
Last updated 3 months ago by mattkime .
Apache · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install github-xyz 
SYNC missed versions from official npm registry.

github-checks-reporter

Task wrapper that provides expressive CI feedback via GitHub checks

Usage

yarn run github-checks-reporter ${task title} ${...command and command args}

example

yarn run github-checks-reporter jest node scripts/jest

Setup

yarn add --dev github-xyz (package name will be updated)

github-checks-reporter relies on a number of environment variables in order to call the GitHub API -

Value Default environment variable
appKey GITHUB_CHECKS_REPORTER_KEY
appId GITHUB_CHECKS_REPORTER_ID
repoSlug ghprbGhRepository
commitSha ghprbActualCommit
buildUrl BUILD_URL

Different environment variables can be used via the github_checks_api.json config file located in the project root.

Example -

{
  "envVars": {
    "appKey": "KIBANA_CI_REPORTER_KEY"
  }
}

How it works

github-checks-reporter takes a task title and a shell command and its arguments and:

  • Creates a check via the GitHub checks API
  • Executes the command
  • Stores and passes along log data and exit code
  • Updates the check based on the exit code, appending log data to the check

Current Tags

  • 0.0.21                                ...           latest (3 months ago)

21 Versions

  • 0.0.21                                ...           3 months ago
  • 0.0.20                                ...           3 months ago
  • 0.0.19                                ...           3 months ago
  • 0.0.18                                ...           3 months ago
  • 0.0.17                                ...           3 months ago
  • 0.0.16                                ...           3 months ago
  • 0.0.15                                ...           3 months ago
  • 0.0.14                                ...           3 months ago
  • 0.0.13                                ...           3 months ago
  • 0.0.12                                ...           3 months ago
  • 0.0.11                                ...           3 months ago
  • 0.0.10                                ...           3 months ago
  • 0.0.9                                ...           3 months ago
  • 0.0.8                                ...           3 months ago
  • 0.0.7                                ...           3 months ago
  • 0.0.6                                ...           3 months ago
  • 0.0.5                                ...           3 months ago
  • 0.0.4                                ...           3 months ago
  • 0.0.3                                ...           3 months ago
  • 0.0.2                                ...           3 months ago
  • 0.0.1                                ...           3 months ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (5)
Dev Dependencies (0)
None
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |