abak-flow 0.1.1 → 0.1.2

data/README.md

@@ -3,12 +3,12 @@ Abak-flow
 Нет, это не новая идеология ведения проекта, это всего лишь набор утилит которые помогают связать использование git-flow и github
 
 # Концепция
-Идеология git-flow использует слудующий набор веток:
+Идеология git-flow использует следующий набор веток:
 
 * *master* - всегда пригодна для развертывания
 * *develop* - основная ветка разработки
 * *hotfix* - ветка для изменений которые попадут на продакшен сервер
-* *feature* - ветки для крупных задачь
+* *feature* - ветки для крупных задач
 
 Github-flow же наоборот ведет основную разработку в ветке master, но при этом master является пригодным для развертывания в любой момент.
 
@@ -22,13 +22,71 @@ Github-flow же наоборот ведет основную разработк
 
 
 # Установка
-*в процессе*
+
+    $ gem install abak-flow
+    $ git config --global alias.request '!request'
+    $ git config --global github.user AwesomeCoder
+    $ git config --global github.token 0123456789yourf0123456789token
+    $ git remote add upstream git://github.com/anonimus/example.git
 
 # С чего начать?
-    $ git request help
+
+    $ git request --help
 
 # Примеры использования
-*в процессе*
+### Самый простой способ начать новую задачу:
+
+    $ git checkout develop
+    $ git request feature
+    $ touch 'hello.txt' && echo 'Hello world!' > hello.txt
+    $ git commit -a -m 'Hello world commit'
+    $ git request publish
+
+Теперь то же самое, только словами:
+
+* Переключимся в ветку develop
+* Abak-flow создаст ветку, пригодную для оформления pull request (правила именования и правила самого реквеста)
+* Простое создание нового файла
+* Git процедуры добавления своих изменений в репозиторий
+* Затем публикация вашей ветки на вашем форке (если таковая уже есть, то просто обновление), затем оформление pull request из этой ветки в соответствующую правилам ветку на upstream (в данном случае это будет ветка develop)
+
+Для задач, которые должны быть выполнены в виде hotfix принцип тот же:
+
+    $ git checkout master
+    $ git request hotfix
+    $ …
+    $ git request publish
+
+*На самом деле переключаться на master или develop в самом начале вовсе не обязательно, этот шаг был приведен для пущей ясности*
+
+### Обновление ветки на удаленном репозитории:
+
+    $ git checkout feature/TASK-001
+    $ git request update
+
+### Завершение текущей задачи:
+Вообще, завершать задачу лучше только после того, как ваш pull request был принят. Почему? На самом деле по ряду причин. По умолчанию эта команда удаляет как вашу текущую ветку с задачей в локальном репозитории и в добавок ко всему - на вашем удаленном репозитории (форке)
+
+    $ git co feature/TASK-001
+    $ git request done 
+
+Чтобы оставить какую либо ветку в живых возможно напрямую указать, какую копию ветки **удалить**, локальную или же удаленную (на origin)
+
+    $ git co feature/TASK-001
+    $ git request done --origin
+
+Или же так
+
+    $ git co feature/TASK-001
+    $ git request done --local
+
+### Маленькие хитрости
+Если сразу правильно именовать ветки, т.е ветку с задачей создавать с именем, такого формата TASK-001, то, в описание pull request автоматически вставится ссылка на задачу в jira
+
+### А помощь?
+Многие команды имеют какие-то дополнительные опции. Но они нужны только в экзотических случаях. Но при любом раскладе подсказку и тонкий намек всегда можно получить воспользовавших такой командой:
+
+    $ git request done --help
 
 # В заключении
 Данный репозиторий и изложенные в нем идеи ни в коем случае не претендуют на идеал и совершенство. Это всего лишь узко заточенная комбинация гемов

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/abak-flow/request.rb

@@ -57,7 +57,7 @@ module Abak::Flow
       Hub::Runner.execute('push', repository.main_project.remote.name, current_branch)
 
       # Запостим pull request на upstream
-      command_options = ['pull-request', args.first, '-b', base, '-h', head, '-d']
+      command_options = ['pull-request', args.first, '-b', base, '-h', head]
       command_options |= ['-d', jira_browse_url + task] if task =~ /^\w+\-\d{1,}$/
 
       say '=> Делаю pull request на upstream'
@@ -82,6 +82,46 @@ module Abak::Flow
     end
   end
 
+  command :feature do |c|
+    c.syntax      = 'git request feature <Название задачи>'
+    c.description = 'Создать ветку для выполнения задачи. Лучше всего, если название задачи, будет ее номером из jira'
+
+    c.action do |args, options|
+      task = args.shift.to_s
+
+      if task.empty?
+        say 'Необходимо указать имя задачи, а лучше всего ее номер из jira'
+        exit
+      end
+
+      unless task =~ /^\w+\-\d{1,}$/
+        say '=> Вы приняли верное решение :)' && exit unless agree("Лучше всего завести задачу с именем примерно такого формата PC-001, может попробуем заного? [yes/no/y/n]:")
+      end
+
+      Hub::Runner.execute('flow', 'feature', 'start', task)
+    end
+  end
+
+  command :hotfix do |c|
+    c.syntax      = 'git request hotfix <Название задачи>'
+    c.description = 'Создать ветку для выполнения bugfix задачи. Лучше всего, если название задачи, будет ее номером из jira'
+
+    c.action do |args, options|
+      task = args.shift.to_s
+
+      if task.empty?
+        say 'Необходимо указать имя задачи, а лучше всего ее номер из jira'
+        exit
+      end
+
+      unless task =~ /^\w+\-\d{1,}$/
+        say '=> Вы приняли верное решение :)' && exit unless agree("Лучше всего завести задачу с именем примерно такого формата PC-001, может попробуем заного? [yes/no/y/n]:")
+      end
+
+      Hub::Runner.execute('flow', 'hotfix', 'start', task)
+    end
+  end
+
   command :done do |c|
     c.syntax      = 'git request done'
     c.description = 'Завершить pull request. По умолчанию удаляются ветки как локальная (local), так и удаленная (origin)'
@@ -106,6 +146,7 @@ module Abak::Flow
         say '=> Вы приняли верное решение :)' && exit unless agree("#{warning} [yes/no/y/n]:")
       end
 
+      # @TODO Проверку на наличие ветки на origin
       if [:all, :origin].include? type
         say "=> Удаляю ветку #{branch} на origin"
         Hub::Runner.execute('push', repository.main_project.remote.name, ':' + branch)

data/lib/abak-flow/version.rb

@@ -1,5 +1,5 @@
 module Abak
   module Flow
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: abak-flow
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-04 00:00:00.000000000Z
+date: 2012-02-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hub
-  requirement: &70178034266540 !ruby/object:Gem::Requirement
+  requirement: &70312825724080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70178034266540
+  version_requirements: *70312825724080
 - !ruby/object:Gem::Dependency
   name: commander
-  requirement: &70178046022640 !ruby/object:Gem::Requirement
+  requirement: &70312825723660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70178046022640
+  version_requirements: *70312825723660
 description: Простой набор правил и комманд, заточеных для работы в git-flow с использование
   в качестве удаленного репозитория github
 email: