eliranmal/git-flux

git commands for fluent, collaborative workflow

git-flux

git commands for fluent, collaborative workflow

prerequisites

this tool relies on bash/mingw32, so:

linux/mac users
just fire up the terminal. you're good to go.

windows people
open your git-bash 'as administrator', please.
(by the way, does it open up in U:\? this might help).

setup

install

curl -O https://raw.githubusercontent.com/eliranmal/git-flux/master/bin/setup.sh
chmod u+x setup.sh
./setup.sh

(windows users can skip the chmod bit).

update

after git-flux is installed, you can use the update subcommand to update git-flux with git-flux (mind = blown):

git flux update [<tag>]

use a tag if you want a specific version.

you can also use the setup script for that, but that's way less cool:

[env REPO_REF=<tag>] ./setup.sh update

uninstall

./setup.sh uninstall

usage

from the terminal, use the -h flag anywhere, or see the usage directory of this repository for the markdown-formatted help.

gotcha's

• if you git rebase --onto (which you shouldn't), bad stuff will happen. why? because the branch base (for started features, createed teams, etc.) is saved to the git config, and not dynamically resolved via git.

contributing

thank you ❤️ read this.

git-flux's Issues

customize bash prompt (PS1)

add state messages on the custom bash prompt line

add 'show' action to all relevant levels

e.g.:

$ git flux team show
>    superstars

$ git flux feature show
>    async_chat
>    foo_bar

[git-bash] pull failed

creation of new branches (e.g. git flux team create [name] fails when pulling from the base remote.

sync delegation

consider delegating sync operations all the way up the bases tree.
ask yourself if it's smart.

self-update

support update git-flux from within git-flux.

• poc
• implementation
  • add the update command
  • pass the repo path to the setup script to work from within the cloned repo
  • take care of proper versioning
• documentation

create command shorthand aliases

e.g. int for integration, feat for feature.

Issue in git flux review (Git Bash)

While using Git Bash to run git flux review, getting error:

$ git flux team review cmfe

➤ type in your github user name: tomers

➤ type in your github password:

creating an access token on 'lpgithub.dev.lprnd.net'...
✔ created ok
creating pull-request from 'team/cmfe' to 'integration'...
sed: -e expression #1, char 2: invalid usage of line address 0
sed: -e expression #1, char 2: invalid usage of line address 0
✘ create failed: 'missing_field'

config should be context aware

• preparations: integration/team branches should be stored in the config the same way as other branches, i.e. as a section, with a base property.
• limit gitconfig context to repo level
• create migration script (publish as gist)
• bump minor/major version

team destroy does not remove the base from config

implement the full git model

here's a reference, do it to lose dependencies with tagging/release/bumping tools.

init fails to push integration on empty repositories

steps to reproduce:

• create a new repo on github, don't add anything, no readme, no license etc.
• clone locally
• cd to it and run git flux init

override usage per action

user should get usage per action, e.g.:

• explicit help flag:

  $ git flux feature start -h
  > usage: git flux feature start <name>
  > 
  > ... long usage ...
  

• wrong usage:

  $ git flux hf start 1.1.1
  > usage: git flux hf start <name> <tag>
  

support dual-base feature branches

support syncing a feature branch with both a hotfix base and a team base, to ease up development when writing bug-fixes for hot-fix releases.

add support for feature base

allow overriding the base branch in the 'feature' subcommand

iterm2 fails on tput commands

errs with "unknown terminfo capability".. add defensive code to discard stderr and close with a no-op on tput error status.

"branch 'team/*' already exists on the remote"

happens after init, when team remote branch exist remotely and not locally

branch '' doesn't exist locally when finishing non-existing feature

also happens on hf when base is tag

organizational open-source

• document it well (see this issue)
• write unit tests
• migrate repository to the public organization
• search/replace any hard references to the repo url
• update the docs on setup to use the enterprise form:

  curl -H 'Authorization: token [some_token_with_lots_of_characters]' \
     -H 'Accept: application/vnd.github.v3.raw' \
     -O -L https://lpgithub.dev.lprnd.net/raw/eliranm/git-flux/master/bin/setup.sh

• write a blog post (contact vladi regarding the dev-blogs platform)

persist logs

redirect stdout/stderr to *.log to enable sending these logs for investigations of problems.
in debug mode, redirect to debug.log to not pollute the terminal out.

"branch '' does not exist locally" on team sync/join

"branch '' does not exist locally" on feature start

running commands without an assigned team (assignment by team join or team create) will fail as branch.team is not registered in the config.

usage docs generator

create automated tool for generating readme (markdown) docs from terminal usage / bash api.
enhance text formatting module for that purpose.

git-bash: "install: command not found"

git bash fails to install if not opened as admin.

'problems parsing json' on pull-request creation

when double quotes appear in the commit message, the review task fails with this error:

creating pull-request from 'feature/stuff' to 'team/stars'...
    ✘ create failed: 'Problems parsing JSON'

to solve it, we should escape the message before putting it in the json data before sending the PR request internally.

DRY up IO

generalize prompting in the terminal to encapsulate all that verbosity in git-flux-init

support update command in installer

add update command to setup.sh, that deletes the local repo to avoid the installer cache, and then calls uninstall and install.

team join should prompt for team creation (if not created)

tag doesn't exist

improve documentation

• don't duplicate usage of commands in readme, just refer users to the -h flag. no, better yet, auto-generate README.md with a script (gen-doc.sh?)
• write an overview of the git-flux model, specifically the levels.
• elaborate on teams and the ability to switch teams with the join action
• state the fact that git-flux addresses some of the issues in git-flow (e.g. we never use --no-ff, all merges are done with default strategy)

add 'search' sub-command

enable history grep with:

git flux search <term>

implementation will use git log -S<term> under the hood (reference).

document it as well.

add interactive prompt for empty-args actions

e.g.:

$ git flux feature start
> chose a feature:
>    foo
>  ➤ bar
>    wat
>    wow

integration handling on init

prompt for creating new integration branch on init

add builtin PR support

integrate hub for pull-requests with proper base (default should not be master)

add default actions for all levels

e.g. the feature's default action will be start, so you can type git flux feature my_feature without the start action name.

Can't initialize when integration already exists

dogfooding

add autocompletion

references

• http://www.linuxjournal.com/content/more-using-bash-complete-command
• http://tldp.org/LDP/abs/html/tabexpansion.html
• https://www.gnu.org/software/bash/manual/html_node/Programmable-Completion.html

libraries

• https://github.com/scop/bash-completion (used by yarn)

team create fails

investigation.zip

remove branch with base fails to delete local when remote is already gone

Upon finish rc branch, in case the remote had already been deleted, git flux will fail deleting the remote and will not continue to delete the local branch

git flux rc finish 8.3.0.0

? local and remote branches will be deleted, forever! continue? (y/n) y

✘ branch 'rc/8.3.0.0' don't exist on the remote.

add unit tests

explore these libs (ordered by # of stars in github)

• bats
• assert.sh
• shunit2
• epoxy
• bashtest

windows: intellij idea terminal not recognizing git-flux

why does intellij's terminal not recognizing git flux on windows?

"working tree is not clean" on fresh setup

happens after unsuccessful init, and than a successful one, on a fresh repo.

support epics

introduce 'epic' level, capable of aggregating teams or features.
this may be redundant, as these flows are covered by team join/feature start name base.