Skip to content

Commit ca9d867

Browse files
committed
Readme
1 parent 6ffa8a8 commit ca9d867

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

cmd/tag-release-tui/README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ go build -o bin/tag-release-tui ./cmd/tag-release-tui
7474
Use the `--test` flag to run the application in test mode:
7575

7676
```bash
77-
./tag-release-tui v1.2.3 --test
77+
./bin/tag-release-tui v1.2.3 --test
7878
```
7979

8080
In test mode, the application will:
@@ -89,6 +89,23 @@ This is perfect for:
8989
- Training or demonstration purposes
9090
- CI/CD validation workflows
9191

92+
## Remote Selection
93+
94+
Use the `--remote` flag to specify which git remote to use:
95+
96+
```bash
97+
# Test against your fork instead of upstream
98+
./bin/tag-release-tui v1.2.3 --remote omgitsads --test
99+
100+
# Actually release to your fork (be careful!)
101+
./bin/tag-release-tui v1.2.3 --remote omgitsads
102+
```
103+
104+
This is especially useful for:
105+
- Testing against your personal fork
106+
- Avoiding accidental releases to upstream repositories
107+
- Working in organizations with multiple remotes
108+
92109
## Error Handling
93110

94111
The application will show detailed error messages if any validation step fails, such as:
@@ -113,6 +130,15 @@ This TUI version provides the same functionality as the original `script/tag-rel
113130

114131
Currently configured for:
115132
- **Allowed Branch**: `tag-release-charmbracelet` (for development/testing)
133+
- **Default Remote**: `origin` (can be overridden with `--remote` flag)
116134
- **Target Branch**: Can be modified in the source code for production use
117135

118136
To use with the main branch in production, change the `allowedBranch` parameter in the `performValidation` call.
137+
138+
## Safety Features
139+
140+
- **Build Location**: Application builds to `bin/` directory (ignored by git)
141+
- **Remote Selection**: Safely test against your fork instead of upstream
142+
- **Test Mode**: Comprehensive validation without making changes
143+
- **Clear Confirmation**: Shows exactly what will happen before proceeding
144+
- **Error Prevention**: Validates all requirements before starting

0 commit comments

Comments
 (0)