Skip to content

Commit e45bee2

Browse files
author
nejc
committed
feat: simplify package to 3 essential commands
BREAKING CHANGE: Removed redundant commands for better UX - Removed laravelplus:pr command (functionality merged into laravelplus:update) - Removed laravelplus:sync command (use laravelplus:update --direct instead) - Consolidated PR creation logic into UpstreamUpgradeCommand - Updated service provider to register only 3 commands - Updated README with simplified workflow and examples - Added clear 3-step workflow at the top of README - Updated all examples to show numbered steps - Emphasized PR-first workflow throughout documentation New simplified workflow: 1. php artisan laravelplus:setup (one-time) 2. php artisan laravelplus:check (check for updates) 3. php artisan laravelplus:update (apply updates, creates PR by default) Benefits: - Simpler to understand and remember - Less confusion about which command to use - Better user experience - Clear workflow progression - Maintains all functionality with fewer commands
1 parent 0beb510 commit e45bee2

File tree

5 files changed

+304
-758
lines changed

5 files changed

+304
-758
lines changed

README.md

Lines changed: 36 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,21 @@
1212

1313
A professional Laravel package for syncing with upstream repositories (GitHub, GitLab, Bitbucket, etc.) with comprehensive testing, modern architecture, and enterprise-grade features. **This package is exclusively designed for Laravel 12** and provides a safe, PR-first workflow for keeping your Laravel starter kit projects up to date!
1414

15+
## 🚀 Simple 3-Step Workflow
16+
17+
```bash
18+
# 1. Setup (one-time)
19+
php artisan laravelplus:setup
20+
21+
# 2. Check for updates
22+
php artisan laravelplus:check
23+
24+
# 3. Apply updates (creates PR by default)
25+
php artisan laravelplus:update
26+
```
27+
28+
That's it! No complex commands to remember - just 3 simple steps to keep your Laravel starter kit up to date.
29+
1530
## ⚠️ Laravel 12 Exclusive
1631

1732
> **Important**: This package is **exclusively designed for Laravel 12** and will not work with older Laravel versions. It leverages Laravel 12's modern architecture and features to provide the best possible experience.
@@ -33,6 +48,11 @@ Welcome to the **LaravelPlus** community! We're building tools that make Laravel
3348

3449
## ✨ Features
3550

51+
### 🎯 **Simple & Powerful**
52+
- **3 Essential Commands** - `setup`, `check`, `update` - that's it!
53+
- **PR-First Workflow** - Always creates pull requests by default for safety
54+
- **Smart Configuration** - Auto-detects your setup and guides you through configuration
55+
3656
### 🔄 **Core Functionality**
3757
- **Universal Git Support** - GitHub, GitLab, Bitbucket, Azure DevOps, self-hosted
3858
- **Multiple Strategies** - Support for both merge and rebase strategies
@@ -217,49 +237,49 @@ php artisan laravelplus:update --direct
217237

218238
#### Vue Starter Kit
219239
```bash
220-
# Setup for Vue starter kit
240+
# 1. Setup for Vue starter kit (one-time)
221241
php artisan laravelplus:setup --preset=vue
222242

223-
# Check for updates
243+
# 2. Check for updates
224244
php artisan laravelplus:check
225245

226-
# Upgrade with updates
246+
# 3. Apply updates (creates PR by default)
227247
php artisan laravelplus:update
228248
```
229249

230250
#### React Starter Kit
231251
```bash
232-
# Setup for React starter kit
252+
# 1. Setup for React starter kit (one-time)
233253
php artisan laravelplus:setup --preset=react
234254

235-
# Check for updates
255+
# 2. Check for updates
236256
php artisan laravelplus:check
237257

238-
# Upgrade with updates
258+
# 3. Apply updates (creates PR by default)
239259
php artisan laravelplus:update
240260
```
241261

242262
#### Livewire Starter Kit
243263
```bash
244-
# Setup for Livewire starter kit
264+
# 1. Setup for Livewire starter kit (one-time)
245265
php artisan laravelplus:setup --preset=livewire
246266

247-
# Check for updates
267+
# 2. Check for updates
248268
php artisan laravelplus:check
249269

250-
# Upgrade with updates
270+
# 3. Apply updates (creates PR by default)
251271
php artisan laravelplus:update
252272
```
253273

254274
#### Custom Repository
255275
```bash
256-
# Setup for custom repository
276+
# 1. Setup for custom repository (one-time)
257277
php artisan laravelplus:setup --preset=custom --url=https://github.com/your-org/your-repo.git
258278

259-
# Check for updates
279+
# 2. Check for updates
260280
php artisan laravelplus:check
261281

262-
# Upgrade with updates
282+
# 3. Apply updates (creates PR by default)
263283
php artisan laravelplus:update
264284
```
265285

@@ -464,24 +484,18 @@ https://username:token@github.com/user/repo.git
464484

465485
## Available Commands
466486

487+
### `laravelplus:setup`
488+
Interactive setup wizard for configuring the package. Run this once to get started.
489+
467490
### `laravelplus:check`
468-
Check if there are updates available from upstream repository.
491+
Check if there are updates available from upstream repository. Shows detailed information about available updates.
469492

470493
### `laravelplus:update`
471494
Upgrade your project with the latest changes from upstream. **Creates PRs by default** (recommended and safest).
472495

473496
### `laravelplus:update --direct`
474497
Apply changes directly without creating a pull request (use with caution).
475498

476-
### `laravelplus:sync`
477-
Direct sync with upstream repository (merges directly to your branch).
478-
479-
### `laravelplus:pr`
480-
Create a pull request with upstream updates (alternative to update --pr).
481-
482-
### `laravelplus:setup`
483-
Interactive setup wizard for configuring the package.
484-
485499
## Command Options
486500

487501
| Option | Description |

0 commit comments

Comments
 (0)