npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

status-back

v1.1.1

Published

Send the status back to the github from CI environment

Downloads

7,298

Readme

status-back v1.1.1

CircleCI codecov Greenkeeper badge

:arrow_left::large_blue_circle: Send the status back to the github from CI environment

:cd: Install

Via npm:

npm i -g status-back

This installs status-back to your system.

CLI Usage

  Usage: status-back [options] [<description>, [<url>]]

  Options:
    --version - - - - - - - - - Output the version.
    -v, --verbose - - - - - - - Output verbose message on internal operations.
    -p, --pending - - - - - - - Set the commit status pending.
    -s, --success - - - - - - - Set the commit status success.
    -f, --failure - - - - - - - Set the commit status failure.
    -e, --error - - - - - - - - Set the commit status error.
    -t, --token <token> - - - - Set the github token. Required.
                                Optionally set by GITHUB_TOKEN env var.
    -r, --repo <repo> - - - - - Set the repo slug. e.g. nodejs/node. Requird.
                                Optionally set by GITHUB_REPO env var.
    --sha1 <sha1> - - - - - - - Set the sha1 of the commit. Default is the current sha1.
                                Optionally set by STATUS_SHA1.
                                If not specified, the sha1 of current dir is used.
    -c, --context <context> - - Set the context of the commit status. e.g. ci/build. Required.
                                Optionally set by STATUS_CONTEXT env var.
    --github-api <url>  - - - - Set the url of the github api. Set this when you use with github enterprise.
                                Optionally set by GITHUB_API env var.

  Example:
    status-back -s -t 12345... -r nodejs/node -c ci/build "build success!" https://ci.server/build/12345

    status-back -f -t 12345... -r nodejs/node -c ci/build "build failure!" https://ci.server/build/12346 --github-api https://github.my-company/api/v3

Examples & recipes

Usage with Jenkins declarative pipeline

In CI settings, we recommend to use environment variables for setting common parameters.

pipeline {
  environment {
    GITHUB_TOKEN = credentials 'github-token'
    GITHUB_API = 'https://mycompany.github/api/v3'
    GITHUB_REPO = 'myorg/myrepo'
  }

  stages {
    stage('install') {
      steps {
        sh 'yarn'
      }
    }

    stage('lint') {
      environment {
        STATUS_CONTEXT = 'jenkins/lint'
      }

      steps {
        sh 'npx status-back -p "Linting..." $BUILD_URL'
        sh 'npm run lint'
      }

      post {
        success {
          sh 'npx status-back -s "Lint success!" $BUILD_URL'
        }
        failure {
          sh 'npx status-back -f "Lint failed!" $BUILD_URL'
        }
      }
    }

    stage('test') {
      environment {
        STATUS_CONTEXT = 'jenkins/test'
      }

      steps {
        sh 'npx status-back -p "Testing..." $BUILD_URL'
        sh 'npm test'
      }

      post {
        success {
          sh 'npx status-back -s "Test success!" $BUILD_URL'
        }
        failure {
          sh 'npx status-back -f "Test failed!" $BUILD_URL'
        }
      }
    }
  }
}

License

MIT

Note: This library is inspired by commit-status by dtinth, but is a bit more focused on usages in Github Enterprise environment, rather than github.com.