Skip to content

Commit 6fd6426

Browse files
author
nejc
committed
docs: update README for Laravel 12 exclusivity and PR-first workflow
- Add prominent Laravel 12 exclusive section with clear warnings - Update all examples to show PR-by-default behavior - Replace --pr option with --direct option in documentation - Update command descriptions to reflect new default behavior - Add GitHub token requirement for PR creation - Update test count from 97 to 113 test cases - Emphasize safety benefits of PR-first workflow - Add clear installation warning for Laravel 12 only The README now clearly communicates that this package: - Is exclusively for Laravel 12 - Creates PRs by default for safer updates - Requires --direct flag for direct application - Provides comprehensive safety features
1 parent c77d09c commit 6fd6426

File tree

1 file changed

+37
-18
lines changed

1 file changed

+37
-18
lines changed

README.md

Lines changed: 37 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,20 @@
77
[![Laravel Version](https://img.shields.io/badge/Laravel-12.0%2B-red.svg?style=flat-square)](https://laravel.com)
88
[![GitHub Stars](https://img.shields.io/github/stars/LaravelPlus/laravel-updater.svg?style=flat-square)](https://github.com/LaravelPlus/laravel-updater)
99
[![GitHub Issues](https://img.shields.io/github/issues/LaravelPlus/laravel-updater.svg?style=flat-square)](https://github.com/LaravelPlus/laravel-updater/issues)
10-
[![Tests](https://img.shields.io/badge/tests-97%20test%20cases-green.svg?style=flat-square)](https://github.com/LaravelPlus/laravel-updater)
10+
[![Tests](https://img.shields.io/badge/tests-113%20test%20cases-green.svg?style=flat-square)](https://github.com/LaravelPlus/laravel-updater)
1111
[![Code Quality](https://img.shields.io/badge/code%20quality-PHPStan%20%7C%20Rector%20%7C%20Pint-blue.svg?style=flat-square)](https://github.com/LaravelPlus/laravel-updater)
1212

13-
A professional Laravel package for syncing with upstream repositories (GitHub, GitLab, Bitbucket, etc.) with comprehensive testing, modern architecture, and enterprise-grade features. Perfect for keeping your Laravel starter kit projects up to date!
13+
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!
14+
15+
## ⚠️ Laravel 12 Exclusive
16+
17+
> **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.
18+
19+
### Why Laravel 12 Only?
20+
- **Modern Architecture** - Built for Laravel 12's streamlined structure
21+
- **Enhanced Security** - Leverages Laravel 12's improved security features
22+
- **Better Performance** - Optimized for Laravel 12's performance improvements
23+
- **Future-Proof** - Designed to grow with Laravel's evolution
1424

1525
## 🚀 LaravelPlus Community
1626

@@ -30,7 +40,7 @@ Welcome to the **LaravelPlus** community! We're building tools that make Laravel
3040
- **Safe Operations** - Dry-run mode and comprehensive error handling
3141

3242
### 🧪 **Testing & Quality**
33-
- **Comprehensive Test Suite** - 97 test cases covering all functionality
43+
- **Comprehensive Test Suite** - 113 test cases covering all functionality
3444
- **Built-in Testing** - Validate configuration and connectivity before syncing
3545
- **Code Quality Tools** - PHPStan, Rector, and Laravel Pint integration
3646
- **Modern Testing** - Pest PHP with Laravel Testbench
@@ -42,8 +52,9 @@ Welcome to the **LaravelPlus** community! We're building tools that make Laravel
4252
- **Easy Setup** - Interactive setup command with beautiful prompts
4353

4454
### 🔀 **Advanced Workflows**
45-
- **Pull Request Workflow** - Create PRs instead of direct merges for safer updates
55+
- **PR-First Workflow** - **Creates PRs by default** for safer updates (Laravel 12 exclusive)
4656
- **GitHub Integration** - Automatic PR creation with GitHub API
57+
- **Direct Application** - Optional direct merge with `--direct` flag when needed
4758
- **Pre/Post Hooks** - Run custom commands before and after sync
4859
- **Flexible Configuration** - Environment variables and command-line overrides
4960

@@ -62,6 +73,8 @@ Welcome to the **LaravelPlus** community! We're building tools that make Laravel
6273

6374
## Installation
6475

76+
> **⚠️ Laravel 12 Only**: This package is exclusively designed for Laravel 12. It will not work with older Laravel versions.
77+
6578
```bash
6679
composer require laravelplus/laravel-updater
6780
```
@@ -151,17 +164,17 @@ GIT_BINARY=git
151164

152165
### Recommended Workflow
153166

154-
The recommended workflow is to check for updates first, then upgrade:
167+
The recommended workflow is to check for updates first, then upgrade. **The package creates PRs by default for safer updates:**
155168

156169
```bash
157170
# 1. Check if updates are available
158171
php artisan laravelplus:check
159172

160-
# 2. If updates are available, upgrade your project
173+
# 2. If updates are available, upgrade your project (creates PR by default)
161174
php artisan laravelplus:update
162175

163-
# 3. Or create a pull request for safer updates
164-
php artisan laravelplus:update --pr
176+
# 3. For direct application (bypasses PR creation)
177+
php artisan laravelplus:update --direct
165178
```
166179

167180
### Quick Start Examples
@@ -241,7 +254,7 @@ php artisan laravelplus:update
241254

242255
## Pull Request Workflow
243256

244-
For safer updates in production environments, you can create pull requests instead of direct merges:
257+
**This package creates pull requests by default** for safer updates in production environments. This is a Laravel 12 exclusive feature that ensures all upstream changes go through proper review:
245258

246259
### Setup GitHub Integration
247260

@@ -263,8 +276,8 @@ GITHUB_REPO=your_repo_name
263276
# Check for updates first
264277
php artisan laravelplus:check
265278

266-
# Create a PR with upstream updates
267-
php artisan laravelplus:update --pr
279+
# Create a PR with upstream updates (default behavior)
280+
php artisan laravelplus:update
268281

269282
# Or use the direct PR command
270283
php artisan laravelplus:pr --test
@@ -274,6 +287,9 @@ php artisan laravelplus:pr --pr-branch=update-vue-starter-kit
274287

275288
# Create PR with custom title and body
276289
php artisan laravelplus:pr --pr-title="Update from Vue starter kit" --pr-body="Sync latest changes from upstream"
290+
291+
# For direct application (bypasses PR creation)
292+
php artisan laravelplus:update --direct
277293
```
278294

279295
### PR Workflow Benefits
@@ -416,10 +432,10 @@ https://username:token@github.com/user/repo.git
416432
Check if there are updates available from upstream repository.
417433

418434
### `laravelplus:update`
419-
Upgrade your project with the latest changes from upstream (recommended).
435+
Upgrade your project with the latest changes from upstream. **Creates PRs by default** (recommended and safest).
420436

421-
### `laravelplus:update --pr`
422-
Create a pull request with upstream updates (safer for production).
437+
### `laravelplus:update --direct`
438+
Apply changes directly without creating a pull request (use with caution).
423439

424440
### `laravelplus:sync`
425441
Direct sync with upstream repository (merges directly to your branch).
@@ -434,6 +450,7 @@ Interactive setup wizard for configuring the package.
434450

435451
| Option | Description |
436452
|--------|-------------|
453+
| `--direct` | Apply changes directly without creating a pull request |
437454
| `--dry-run` | Show what would happen without executing |
438455
| `--test` | Test configuration and connectivity before sync |
439456
| `--no-pre` | Skip pre_update hooks |
@@ -449,7 +466,7 @@ Interactive setup wizard for configuring the package.
449466

450467
## 🧪 Testing
451468

452-
This package includes a comprehensive test suite with **97 test cases** covering all functionality:
469+
This package includes a comprehensive test suite with **113 test cases** covering all functionality:
453470

454471
### Test Coverage
455472
- **Unit Tests** - Core components, services, and utilities
@@ -521,18 +538,20 @@ We welcome contributions! Please see our [Development Guide](DEVELOPMENT.md) for
521538
## Requirements
522539

523540
- **PHP 8.4+** - Latest PHP features and performance
524-
- **Laravel 12.0+** - Latest Laravel framework
541+
- **Laravel 12.0+** - **Exclusively designed for Laravel 12** (will not work with older versions)
525542
- **Git** - Installed and accessible in PATH
526543
- **Valid Git Repository** - Working directory must be a Git repository
544+
- **GitHub Token** - Required for PR creation (optional for direct sync)
527545

528546
## License
529547

530548
This package is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
531549

532550
## 📊 Package Statistics
533551

534-
- **97 Test Cases** - Comprehensive test coverage
535-
- **Modern Architecture** - PHP 8.4 + Laravel 12
552+
- **113 Test Cases** - Comprehensive test coverage
553+
- **Modern Architecture** - PHP 8.4 + Laravel 12 exclusive
554+
- **PR-First Workflow** - Creates PRs by default for safer updates
536555
- **Code Quality** - PHPStan Level 8 + Rector + Pint
537556
- **Zero Dependencies** - Only Laravel framework dependencies
538557
- **Universal Support** - Works with any Git hosting service

0 commit comments

Comments
 (0)