okada-takuya / octaccord

Create Iteration pages automatically from Github issues

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

octaccord

Octaccord

What is octaccord?

Octaccord is a small CLI tool to manipulate issues (tickets) for the GitHub. It reduces some complex operations on the issues of GitHub:

  • Bulk label update with complex search queries
  • Pretty issue printer in many format including Markdown
  • Extract statistic information to the GitHub Wiki

INSTALL for developers:

Current code is a very alpha and kind of proof-of-concept demonstration. I recommend you not to install via usual gem-style procedure.

  1. Install rbenv + ruby-build (see https://github.com/sstephenson/rbenv#basic-github-checkout for details)
    $ git clone https://github.com/sstephenson/rbenv.git ~/.rbenv
    $ git clone https://github.com/sstephenson/ruby-build.git ~/.rbenv/plugins/ruby-build
    # Edit your shell dot files to add some path and environment variables.
        
  2. Install Latest Ruby and bundler
    # Install ruby 2.1.2
    $ rbenv install 2.1.2
    
    # Installation check
    $ rbenv global 2.1.2
    $ ruby -v # -> You will see: ruby 2.1.2...
    
    # Install bundler for your new Ruby
    $ gem install bundler
    
    # Get back to your sytem default Ruby if you want
    $ rbenv global system # say, /usr/bin/ruby
    $ ruby -v
        
  3. Clone octaccord from github
    $ git clone git@github.com:nomlab/octaccord.git ~/src/octaccord
        
  4. Set default ruby version in octaccord project
    $ cd ~/src/octaccord
    $ echo '2.1.2' > .ruby-version
    $ ruby -v # -> You will see: ruby 2.1.2...
        
  5. Install requied gem packages in sandbox ~/src/octaccord/vendor/bundle
    $ cd ~/src/octaccord
    $ bundle install --path vendor/bundle
        
  6. Setup data-cache and auth-cache directory
    $ mkdir -p ~/.cache/octaccord
    $ mkdir -p ~/.pit
        
  7. Check if octaccord is alive.
    $ export EDITOR=vi
    $ ~/src/octaccord/bin/octaccord scan nomlab/octaccord
        

You may add ~/src/octaccord/bin directory to your $PATH for dogfooding. If you are zsh user, examples/octaccord-completion.zsh would help you.

About

Create Iteration pages automatically from Github issues

License:MIT License


Languages

Language:Ruby 90.5%Language:HTML 9.1%Language:Shell 0.5%