tbdflow 0.34.0

A CLI to streamline your Git workflow for Trunk-Based Development.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

# ═══════════════════════════════════════════════════════════════════════════════
# tbdflow — Branch Creation & Naming
# ═══════════════════════════════════════════════════════════════════════════════
# User Story: As a developer, I want to create short-lived branches with
# consistent naming so that my team can understand work-in-progress at a glance.
# ═══════════════════════════════════════════════════════════════════════════════

feature "tbdflow Branch Creation"

actors: Terminal

settings {
    timeout_seconds = 30
    stop_on_failure = true
    shell_path = "/bin/bash"
}

var REPO_DIR = "/tmp/tbdflow_branch_test"
var BARE_REPO = "/tmp/tbdflow_branch_bare.git"

# ═══════════════════════════════════════════════════════════════════════════════
# IMPLEMENTATION LAYER — Tasks hide the "how"
# ═══════════════════════════════════════════════════════════════════════════════

task init_repo(repo, bare) {
    Terminal run "rm -rf ${repo} ${bare} && mkdir -p ${repo}"
    Terminal run "git init --bare ${bare}"
    Terminal run "git -C ${repo} init && git -C ${repo} commit --allow-empty -m 'init'"
    Terminal run "git -C ${repo} remote add origin ${bare}"
    Terminal run "git -C ${repo} push -u origin main"
    Terminal set_cwd "${repo}"
}

task cleanup_repo(repo, bare) {
    Terminal run "rm -rf ${repo} ${bare}"
}

task create_branch(type, name) {
    Terminal run "tbdflow branch -t ${type} -n ${name}"
}

task create_branch_with_issue(type, name, issue) {
    Terminal run "tbdflow branch -t ${type} -n ${name} --issue ${issue}"
}

task return_to_main() {
    Terminal run "git checkout main"
}

task verify_branch_created(expected_name) {
    Terminal last_command succeeded
    Terminal output_contains "${expected_name}"
    Terminal output_not_contains "Error"
}

# ═══════════════════════════════════════════════════════════════════════════════
# BUSINESS SPECIFICATION LAYER — Scenarios describe the "what"
# ═══════════════════════════════════════════════════════════════════════════════

# AC1: Branches must follow the <type>/<name> convention.
# AC2: Issue keys must be embedded in the branch name when provided.
# AC3: Multiple branch types (feat, fix, chore) must be supported.

scenario "Creating short-lived branches" {

    test Setup "Initialise test repository" {
        given:
            Test can_start
        when:
            init_repo("${REPO_DIR}", "${BARE_REPO}")
        then:
            Terminal last_command succeeded
    }

    test FeatBranch "Create a feature branch" {
        given:
            Test has_succeeded Setup
        when:
            create_branch("feat", "add-user-profile")
        then:
            verify_branch_created("feat/add-user-profile")
    }

    test BranchWithIssue "Create a branch with an issue key" {
        given:
            Test has_succeeded FeatBranch
            return_to_main()
        when:
            create_branch_with_issue("fix", "resolve-timeout", "API-456")
        then:
            verify_branch_created("fix/API-456-resolve-timeout")
    }

    test ChoreBranch "Create a chore branch" {
        given:
            Test has_succeeded BranchWithIssue
            return_to_main()
        when:
            create_branch("chore", "update-deps")
        then:
            verify_branch_created("chore/update-deps")
    }

    after {
        cleanup_repo("${REPO_DIR}", "${BARE_REPO}")
    }
}