Giter Club home page Giter Club logo

precis's Introduction

Precis

Build Status

CLI application for getting information out of various systems in a neat dashboard format. This is inspired from @jessfraz/tdash's dashboard

It integrates with:

  • GitHub
  • Jenkins

Usage

.______   .______       _______   ______  __       _______.
|   _  \  |   _  \     |   ____| /      ||  |     /       |
|  |_)  | |  |_)  |    |  |__   |  ,----'|  |    |   (----
|   ___/  |      /     |   __|  |  |     |  |     \   \
|  |      |  |\  \----.|  |____ |   ----.|  | .----)   |
| _|      | _|  ._____||_______| \______||__| |_______/

A terminal dashboard which gives an overview of useful things

Build:

  -display-build
        Do you want to show build information from Jenkins? (default true)
  -display-github
    	Do you want to show GitHub information? (default true)
  -github-owner string
    	The GitHub CI owner (or define env var GITHUB_OWNER)
  -github-token string
    	The GitHub CI authentication token (or define env var GITHUB_TOKEN)
  -interval string
    	The refresh rate for the dashboard (default "60s")
  -jenkins-password string
    	The Jenkins password to authenticate with (or define env var JENKINS_PASSWORD)
  -jenkins-url string
    	The Jenkins URL (or define env var JENKINS_URL)
  -jenkins-username string
    	The Jenkins username to authenticate with (or define env var JENKINS_USERNAME)
  -jenkins-view string
    	The Jenkins view you want render, otherwise it is all (or define env var JENKINS_VIEW)

Requirements

If you are wanting to build and develop this, you will need the following items installed.

  • Go version 1.11+

Configuration

You will need the following environment variables defining, depending on which systems you are running in the dashboard:

export GITHUB_TOKEN=""
export GITHUB_OWNER=""
export JENKINS_URL=""
export JENKINS_USERNAME=""
export JENKINS_PASSWORD=""
export JENKINS_VIEW=""

You can also define ~/.benmatselby/precis.yml which has various settings.

Limiting the repos to show Pull Requests for

github:
  pull_request_repos:
  - my-org/my-repo
  - benmatselby/*

Installation via Git

git clone [email protected]:benmatselby/precis.git
cd precis
make all
./precis

You can also install into your $GOPATH/bin by go install

precis's People

Contributors

benmatselby avatar markgaze avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

precis's Issues

Handle failure gracefully

Currently, if any service that Precis is connected to returns an error state, the whole process is killed. It would be nice if it could continue running until the service comes back online (or I quit to fix my config) as I might still be able to pull back GitHub PRs but not connect to Jenkins and I still want to see the PRs without restarting.

The ability to hide certain repos from the dashboard

It would be good if you could have a list of repos to ignore from the dashboard (Deprecated repos, work/personal repos etc)

This would need to be an environment variable past into the application/container.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.