Skip to content
This repository has been archived by the owner on Dec 7, 2021. It is now read-only.

Latest commit

 

History

History
66 lines (48 loc) · 2.24 KB

README.rdoc

File metadata and controls

66 lines (48 loc) · 2.24 KB

<img src=“https://codeclimate.com/github/MaximilianMeister/nailed/badges/gpa.svg” />

nailed

What is nailed?

nailed consists of a back-end CLI for data collection and a sinatra based web front-end for visualization of relevant development data of Products that have their bugtracker on Bugzilla and (optionally) their codebase on GitHub and their CI on Jenkins.

Be aware that the bugzilla layout (metadata) is still SUSE specific, which may not be useful for everybody. e.g. it relies on bugs being tagged as L3. The plan is to make it optional in the future.

Installation using gem

gem install 'nailed'

Note that this is always a bit outdated.

Installation using git (recommended)

You can use nailed directly from a git checkout as well. Make sure to fetch the dependencies and call ‘nailed` from the `bin` directory.

SUSE

zypper in libxml2-devel sqlite3-devel gcc make ruby-devel
bundle install

Usage

$ nailed -h
Options:
          --new, -n:   Create new database
      --migrate, -m:   Set database to pristine state
      --upgrade, -u:   Upgrade database
     --bugzilla, -b:   Refresh bugzilla database records
       --github, -g:   Refresh github database records
     --list, -l <s>:   List github repositories within organization
       --server, -s:   Start a dashboard webinterface
         --help, -h:   Show this message

Initial setup

  • for the bugzilla API make sure you have an .oscrc file with your credentials in ~

  • for the github API make sure you have a .netrc with a valid GitHub OAuth-Token in ~

    # example .netrc
    
    machine api.github.com
      login MaximilianMeister
      password <your OAuth Token>
  • configure your config/config.yml

  • to setup the database run

    nailed --migrate
    

Configuration

All configuration is read from config/config.yml

Changes in production

  • in production, after adding products/changes, to upgrade the database with the new changes run

    nailed --upgrade
    
  • make sure to fetch new data with

    nailed --bugzilla
    nailed --github
    
  • restart the webserver

Run

  • create a cronjob for automated data collection with nailed

  • start the webserver with

    nailed --server