bgit 0.4.2

User-friendly Git wrapper for beginners, automating essential tasks like adding, committing, and pushing changes. It includes smart rules to avoid common pitfalls, such as accidentally adding sensitive files or directories and has exclusive support for portable hooks!
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
108
109
110
111
112
113
114
115
116
117
118
119
120

# Project Configuration File Format

## Project Configuration File Location

BGit looks for its configuration file at:

```
<repository_root>/.bgit/config.toml
```

The configuration file is automatically discovered by:

1. Finding the Git repository root using `git2::Repository::discover()`
2. Looking for config.toml in that root directory
3. If not in a Git repository, it looks in the current directory

The configuration file uses TOML format and supports two main sections:

## 1. Rules Configuration

Configure rule behavior using the `[rules]` section:

```toml
[rules.workflow_name]
rule_name = "Level"
```

**Structure:**

- `workflow_name` - Name of the workflow (e.g., `default`)
- `rule_name` - Available inside `src/rules` directory for each named as return value of `self.get_name()` method. (eg: IsGitInstalledLocally, GitNameEmailSetup, NoSecretsStaged etc)

**Available Rule Levels:**

- `"Skip"` - Skip the rule check entirely
- `"Warning"` - Emit a warning if rule fails, try to fix, but continue
- `"Error"` - Emit an error if rule fails, try to fix, but stop if not fixable

**Example:**

```toml
[rules.default]
IsGitInstalledLocally = "Error"
GitNameEmailSetup = "Error"
NoSecretsStaged = "Error"
```

## 2. Workflow Configuration

Configure workflow step flags using the `[workflow]` section:

```toml
[workflow.workflow_name.step_name]
flag_name = value
```

**Structure:**

- `workflow_name` - Name of the workflow (e.g., `default`)
- `step_name` - Name of the step within the workflow (e.g., `git_commit`, `git_push`, `is_sole_contributor`)
- `flag_name` - Name of the flag to override
- `value` - Value to set (can be boolean, integer, string, etc.)

**Example:**

```toml
[workflow.default.is_sole_contributor]
overrideCheckForAuthors = ["email@gmail.com"]
```

## Complete Configuration Example

```toml
# Rules configuration
[rules.default]
IsGitInstalledLocally = "Error"
GitNameEmailSetup = "Error"
NoSecretsStaged = "Error"

# Workflow configurations
[workflow.default.is_sole_contributor]
overrideCheckForAuthors = ["email@gmail.com"]
```

## Default Behavior

- If the configuration file doesn't exist, BGit uses sensible defaults
- Rules without explicit configuration use their default levels
- Workflow flags without configuration use their default values
- All configuration sections are optional

## File Creation

You can also create the file manually:

```bash
mkdir -p .bgit
touch .bgit/config.toml
```

## Best Practices

1. **Start Small**: Begin with a minimal configuration and add settings as needed
2. **Team Configuration**: Commit the config.toml file to share settings with your team
3. **Environment-Specific**: Use different configurations for different environments
4. **Documentation**: Comment your configuration choices for team members

## Troubleshooting

### Configuration Not Loading

- Ensure you're in a Git repository or the file is in the current directory
- Check file permissions (must be readable)
- Verify TOML syntax using a TOML validator

### Invalid Configuration Values

- Rule levels must be exactly: `"Skip"`, `"Warning"`, or `"Error"`
- Flag values must match expected types (boolean, integer, string)
- Workflow and step names must match exactly (case-sensitive)