https://github.com/willnet/deka

tracking commits of a repository
https://github.com/willnet/deka

Last synced: 2 months ago
JSON representation

tracking commits of a repository

• Host: GitHub
• URL: https://github.com/willnet/deka
• Owner: willnet
• License: mit
• Created: 2014-06-17T03:45:24.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-12-13T11:13:16.000Z (about 9 years ago)
• Last Synced: 2024-08-09T10:30:09.916Z (5 months ago)
• Language: Ruby
• Homepage:
• Size: 26.4 KB
• Stars: 4
• Watchers: 0
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Deka

[![Build Status](https://travis-ci.org/willnet/deka.svg?branch=master)](https://travis-ci.org/willnet/deka)

Deka provides `deka` command which track files (ex: README.md) and write github issues if new commits detected. It is useful to translate documents on github and keep them fresh.

### examples of use

- [willnet/capybara-readme-ja](https://github.com/willnet/capybara-readme-ja)

## Installation

Add this line to your application's Gemfile:

    gem 'deka'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install deka

## Usage

* requirement: `git` command

* You should create a config file (ex: `./deka.yml`) and write settings.

* Use `deka` command to watch `watching_repo` and write issues to `issuing_repo`. If you don't want to watch all commits, write a commit hash to `.tracked_hash`, deka doesn't write issues prior to the commit hash.

* `.tracked_hash` if automatically updated by `deka` command

```

Usage: deka [options]

        --dry-run      Dry run

    -c, --config       config path (default `./deka.yml`)

    -s, --save         path for saving tracked hash (default `./.tracked_hash`)

```

### config file example

```

watching_files: 'README.md'

watching_repo: 'willnet/readme_tracker_watching_repo'

issuing_repo: 'willnet/readme_tracker_issuing_repo'

body: 'please respond'

access_token: YOUR_GITHUB_ACCESS_TOKEN

```

## Contributing

1. Fork it ( https://github.com/willnet/deka/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request