README.md in abak-flow-0.2.3 vs README.md in abak-flow-0.3.0
- old
+ new
@@ -1,9 +1,11 @@
Abak-flow
=========
Нет, это не новая идеология ведения проекта, это всего лишь набор утилит которые помогают связать использование [git-flow](https://github.com/nvie/gitflow) и [github flow](http://scottchacon.com/2011/08/31/github-flow.html)
+**Начиная с версии v0.2.1 используется авторизация OAuth2. [Как ей пользоваться](https://github.com/Strech/abak-flow/wiki/How-start-work-with-new-abak-flow)**
+
# Концепция
Идеология git-flow использует следующий набор веток:
* *master* - всегда пригодна для развертывания
* *develop* - основная ветка разработки
@@ -23,13 +25,13 @@
# Установка
$ gem install abak-flow
$ git config --global alias.request '!request'
- $ git config --global abak.apiuser your_github_mail@gmail.com
- $ git config --global abak.apitoken 0123456789yourf0123456789token
- $ git remote add upstream git://github.com/github_user_name/project.git
+ $ git config --global abak.apiuser YOUR_GITHUB_MAIL@gmail.com
+ $ git config --global abak.apitoken 0123456789YOUR_GITHUB_API_TOKEN
+ $ git remote add upstream git://github.com/GITHUB_PROJECT_USER/GITHUB_PROJECT_NAME.git
### А если я использую прокси, как быть?
$ git config --global abak.proxy http://my-proxy.com:3129
Далее по приоритету идут переменные окружения. Сначала **http_proxy**, затем **HTTP_PROXY**
@@ -44,11 +46,11 @@
# С чего начать?
$ git request readycheck
-или
+или
$ git request help
**Примечание:** Вообще-то все комманды поддерживают опцию *--help*, но вот именно *git request --help* успевает перехватиться самим git и он конечно неодумевает как ему показать хэлп по внешней комманде
@@ -59,10 +61,12 @@
$ git request feature 'TASK-001'
$ touch 'hello.txt' && echo 'Hello world!' > hello.txt
$ git commit -a -m 'Hello world commit'
$ git request publish
+**Внимание:** Не нужно называться ветку TASK. Используйте префикс задачь из jira
+
Теперь то же самое, только словами:
* Переключимся в ветку develop
* Abak-flow создаст ветку, пригодную для оформления pull request (правила именования и правила самого реквеста)
* Простое создание нового файла
@@ -84,21 +88,21 @@
$ git request update
### Завершение текущей задачи:
Вообще, завершать задачу лучше только после того, как ваш pull request был принят. Почему? На самом деле по ряду причин. По умолчанию эта команда удаляет как вашу текущую ветку с задачей в локальном репозитории и в добавок ко всему - на вашем удаленном репозитории (форке)
- $ git co feature/TASK-001
+ $ git checkout feature/TASK-001
$ git request done
Чтобы оставить какую либо ветку в живых возможно напрямую указать, какую копию ветки **удалить**, локальную или же удаленную (на origin)
- $ git co feature/TASK-001
+ $ git checkout feature/TASK-001
$ git request done --origin
Или же так
- $ git co feature/TASK-001
+ $ git checkout feature/TASK-001
$ git request done --local
## Маленькие хитрости
Если сразу правильно именовать ветки, т.е ветку с задачей создавать с именем, такого формата TASK-001, то, в описание pull request автоматически вставится ссылка на задачу в jira, а в имя pull request сразу вставится название, состоящее из имени задачи, т.е TASK-001
@@ -106,6 +110,6 @@
Многие команды имеют какие-то дополнительные опции. Но они нужны только в экзотических случаях. Но при любом раскладе подсказку и тонкий намек всегда можно получить воспользовавших такой командой:
$ git request done --help
# В заключении
-Данный репозиторий и изложенные в нем идеи ни в коем случае не претендуют на идеал и совершенство. Это всего лишь узко заточенная комбинация гемов
\ No newline at end of file
+Данный репозиторий и изложенные в нем идеи ни в коем случае не претендуют на идеал и совершенство. Это всего лишь узко заточенная комбинация гемов