Hooks

git-gamble provides his own custom git hooks to enhance the development workflow

These hooks can be used to perform specific actions before and after gambling

Before Gambling (`pre-gamble`)

The pre-gamble hook is executed before the actual gambling process begins

Sometimes, you want to have certain things imperatively done before gambling on the tests

What if something irrelevant was just missing and that forgetting this was not worth starting again ?

Examples :

Formatting
Linting

After Gambling (`post-gamble`)

The post-gamble hook is triggered after the gambling result is known

Sometimes, you want to do actions after the gamble only in some situations

Examples :

Wrong gamble (pass fail or fail pass)
- Suggest to take a break
Good gamble (pass pass or fail fail)
- Congratulate
Failing tests (fail fail)
- Remember to not push on the main branch
Passing tests (pass pass)
- Run acceptance tests to check the status of the Double Loop TDD / ATDD loop
- Suggest to push
- Push automatically

See more usable examples

If you have more ideas, please share them by opening an issue

Hook Execution and Configuration

Custom hooks are called with arguments :

pre-gamble <GAMBLED>
- pre-gamble hook is executed with one argument <GAMBLED>
post-gamble <GAMBLED> <ACTUAL>
- post-gamble hook is executed with two arguments <GAMBLED> and <ACTUAL>

Where :

<GAMBLED> is pass or fail
<ACTUAL> is pass or fail

Custom hooks of git-gamble are like any other client-side git hooks :

a hook is a file (pre-gamble or post-gamble)
a hook must be in the $GIT_DIR/hooks/ folder
- or in the folder configured by git config core.hooksPath
a hook must be executable
- to make it executable, execute the following command
```
 chmod +x .git/hooks/*-gamble
```
will not be executed if any of these options are used :
- --no-verify
- --dry-run

Hooks Execution Lifecycle

The following diagram shows when custom hooks are executed in relation to standard git hooks

flowchart LR
    subgraph git-gamble's hooks' lifecycle
        direction TB
        git-gamble([git-gamble --pass\nOR\ngit-gamble --fail])
        --> pre-gamble[pre-gamble pass\nOR\npre-gamble fail]:::gitGambleHookStyle
        --> git_add([git add --all]):::gitGambleInternalStyle
        --> GAMBLE_TEST_COMMAND([exec $GAMBLE_TEST_COMMAND]):::gitGambleInternalStyle
        --> gamble{Gamble result ?}:::gitGambleInternalStyle

        gamble -->|Gamble success| Success
        subgraph Success
            direction TB

            git_commit([git commit]):::gitGambleInternalStyle
            --> pre-commit:::gitHookStyle
            --> prepare-commit-msg[prepare-commit-msg\n$GIT_DIR/COMMIT_EDITMSG\nmessage]:::gitHookStyle
            --> commit-msg[commit-msg\n$GIT_DIR/COMMIT_EDITMSG]:::gitHookStyle
            --> post-commit:::gitHookStyle
            post-commit --> rewritten?
            rewritten?{{"Last commit rewritten ?\nWhen gambling fail\nafter another gamble fail"}}:::gitGambleInternalStyle
            rewritten? -->|Yes| post-rewrite[post-rewrite\namend]:::gitHookStyle --> post-gamble-success
            rewritten? -->|No| post-gamble-success
            post-gamble-success[post-gamble pass pass\nOR\npost-gamble fail pass]:::gitGambleHookStyle
        end

        gamble -->|Gamble error| Error
        subgraph Error
            direction TB

            git_reset([git reset --hard]):::gitGambleInternalStyle
            --> post-gamble-error[post-gamble pass fail\nOR\npost-gamble fail fail]:::gitGambleHookStyle
        end
    end

    subgraph Legend
        direction TB

        subgraph Legend_[" "]
            direction LR

            command([Command executed\nby user])
            git-gamble_command([Command executed\nby git-gamble]):::gitGambleInternalStyle
            condition{Condition ?}:::gitGambleInternalStyle
        end

        subgraph Hooks
            direction LR

            hook[git's hook]:::gitHookStyle
            hook_with_argument[git's hook\nfirst_argument\nsecond_argument]:::gitHookStyle
            git-gamble_hook_with_argument[git-gamble's hook\nfirst_argument\nsecond_argument]:::gitGambleHookStyle
        end
    end

    classDef gitHookStyle fill:#f05133,color:black,stroke:black;
    classDef gitGambleHookStyle fill:#5a3730,color:white,stroke:white;
    classDef gitGambleInternalStyle fill:#411d16,color:white,stroke:white;

Textual description of the hooks execution lifecycle

User executes the command git-gamble --pass OR git-gamble --fail
git-gamble executes the hook pre-gamble pass OR pre-gamble fail
git-gamble executes the command git add --all
git-gamble executes the command exec $GAMBLE_TEST_COMMAND
When gamble success
1. git-gamble executes the command git commit
2. git executes the hook pre-commit
3. git executes the hook prepare-commit-msg $GIT_DIR/COMMIT_EDITMSG message
4. git executes the hook commit-msg $GIT_DIR/COMMIT_EDITMSG
5. git executes the hook post-commit
6. When gambling fail after another gamble fail
  1. git executes the hook post-rewrite amend
7. git-gamble executes the hook post-gamble pass pass OR post-gamble fail pass depending on what the user gambled
When gamble error
1. git-gamble executes the command git reset --hard
2. git-gamble executes the hook post-gamble pass fail OR post-gamble fail fail depending on what the user gambled

Keyboard shortcuts

git-gamble

Hooks

Before Gambling (pre-gamble)

After Gambling (post-gamble)

Hook Execution and Configuration

Hooks Execution Lifecycle

Before Gambling (`pre-gamble`)

After Gambling (`post-gamble`)