Project

deka

0.0
No commit activity in last 3 years
No release in over 3 years
tracking commit of README
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.6
>= 0
>= 0

Runtime

~> 3.7.1
~> 4.0.0
 Project Readme

Deka

Build Status

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

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