https://github.com/pepabo/furik

GitHub activity summary for Retrospective
https://github.com/pepabo/furik

Last synced: 1 day ago
JSON representation

GitHub activity summary for Retrospective

• Host: GitHub
• URL: https://github.com/pepabo/furik
• Owner: pepabo
• License: mit
• Created: 2015-11-10T01:30:30.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2023-03-09T23:32:44.000Z (almost 2 years ago)
• Last Synced: 2024-12-25T17:06:06.477Z (8 days ago)
• Language: Ruby
• Homepage:
• Size: 36.1 KB
• Stars: 84
• Watchers: 10
• Forks: 14
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Furik

Furik is summary generator for your GitHub activities.

[![ruby gem](https://img.shields.io/gem/v/furik.svg?style=flat-square)][gem]

[![Travis](https://img.shields.io/travis/pepabo/furik.svg?style=flat-square)][travis]

[gem]: https://rubygems.org/gems/furik

[travis]: https://travis-ci.org/pepabo/furik

## Installation

Install it yourself as:

    $ gem install furik

## Usage

You can show GitHub activity while one day.

    $ furik activity

Output example is here:

```

% furik activity

Today's Activities

-

### ruby/rubyspec

- [pull_request](https://github.com/ruby/rubyspec/pull/158): Set Net::FTP.default_passive to false.

- [comment](https://github.com/ruby/rubyspec/pull/158#issuecomment-155703551): :+1: (Set Net::FTP.default_passive t...)

### ruby/ruby

- [pull_request](https://github.com/ruby/ruby/pull/1091): Fix typo, double 'means'

(snip)

```

If you want to show GitHub and GitHub Enterprise activities, You need to add `-l` option to `furik` command.

    $ furik activity -l

furik supports to store authentication via Pit. You are asked GitHub (and GitHub Enterprise) token from furik.

Pit sotred your token to `~/.pit/default.yaml` by default. You can confirm or modify this yaml.

```sh

% cat ~/.pit/default.yaml

---

github.com:

  access_token: your_token

your.github-enterprise.host:

  access_token: your_enterprise_token

furik:

  github_enterprise_host: your.github-enterpise.host

```

NOTE: `your.github-enterprise.host` should be replaced with your true GH:E hostname(both yaml's key and value).

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec furik` to use the gem in this directory, ignoring other installed copies of this gem.

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pepabo/furik.

## LICENSE

The MIT License (MIT)

Copyright (c) 2015- GMO Pepabo, Inc.