Skip to content

Commit b41fbe0

Browse files
committed
feat(README): enhance cancel command with group filtering options
Added group filtering capabilities to the cancel command for faster sync cancellations. This improves performance significantly in multi-group configurations.
1 parent 9b84153 commit b41fbe0

1 file changed

Lines changed: 23 additions & 4 deletions

File tree

README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -677,9 +677,13 @@ go-broadcast diagnose # Collect system diagnostic information
677677
go-broadcast diagnose > diagnostics.json # Save diagnostics to file
678678

679679
# Cancel active syncs
680-
go-broadcast cancel # Cancel all active sync operations
681-
go-broadcast cancel org/repo1 # Cancel syncs for specific repository
682-
go-broadcast cancel --dry-run # Preview what would be cancelled
680+
go-broadcast cancel # Cancel all active sync operations
681+
go-broadcast cancel org/repo1 # Cancel syncs for specific repository
682+
go-broadcast cancel --groups "core" # Cancel syncs for specific group (much faster!)
683+
go-broadcast cancel --groups "core,security" # Cancel syncs for multiple groups
684+
go-broadcast cancel --groups "core" org/repo1 # Cancel specific repo in a group
685+
go-broadcast cancel --skip-groups "experimental" # Cancel all except experimental group
686+
go-broadcast cancel --dry-run # Preview what would be cancelled
683687

684688
# Review and merge pull requests
685689
go-broadcast review-pr <pr-url> # Review and merge single PR
@@ -888,7 +892,7 @@ groups:
888892
<details>
889893
<summary><strong>❌ Cancel Sync Operations</strong></summary>
890894

891-
When issues arise, you can cancel active sync operations to prevent unwanted changes.
895+
When issues arise, you can cancel active sync operations to prevent unwanted changes. Group filtering makes cancellation much faster for multi-group configurations.
892896

893897
**Cancel sync operations when issues arise:**
894898
```bash
@@ -898,6 +902,16 @@ go-broadcast cancel --config sync.yaml
898902
# Cancel syncs for specific repositories only
899903
go-broadcast cancel company/service1 company/service2
900904
905+
# Cancel syncs for specific groups (much faster for multi-group configs!)
906+
go-broadcast cancel --groups "core"
907+
go-broadcast cancel --groups "core,security"
908+
909+
# Cancel specific repository in a specific group
910+
go-broadcast cancel --groups "third-party-libraries" company/repo1
911+
912+
# Cancel all except experimental group
913+
go-broadcast cancel --skip-groups "experimental"
914+
901915
# Preview what would be cancelled without making changes
902916
go-broadcast cancel --dry-run --config sync.yaml
903917
@@ -908,6 +922,11 @@ go-broadcast cancel --keep-branches --config sync.yaml
908922
go-broadcast cancel --comment "Cancelling due to template update" --config sync.yaml
909923
```
910924

925+
**Performance Benefits:**
926+
- **Without group filtering**: Scans all groups in your config (100+ API calls for 5 groups)
927+
- **With `--groups "core"`**: Scans only the core group (20 API calls)
928+
- **Result**: 5x faster cancellation for multi-group configurations
929+
911930
</details>
912931

913932
<details>

0 commit comments

Comments
 (0)