Skip to content

Commit 5636170

Browse files
committed
docs: prepare release 1.0.3
Document Symfony 6.4/7.4+/8.0/8.1+ compatibility, expand CI matrix, pin demos to Symfony 7.4 and 8.1, and add spec-driven development docs.
1 parent 3243fe0 commit 5636170

26 files changed

Lines changed: 2914 additions & 1147 deletions

.github/workflows/ci.yml

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,16 @@ jobs:
1616
fail-fast: false
1717
matrix:
1818
php: ['8.2', '8.3', '8.4', '8.5']
19-
symfony: ['7.0', '8.0']
19+
symfony: ['7.0', '7.4', '8.0', '8.1']
2020
exclude:
2121
- php: '8.2'
2222
symfony: '8.0'
23+
- php: '8.2'
24+
symfony: '8.1'
2325
- php: '8.3'
2426
symfony: '8.0'
27+
- php: '8.3'
28+
symfony: '8.1'
2529

2630
steps:
2731
- name: Checkout code
@@ -53,9 +57,11 @@ jobs:
5357
- name: Install dependencies with Symfony ${{ matrix.symfony }}
5458
run: |
5559
# Symfony 8 requires PHP >=8.4; composer.json pins platform to 8.2.x for lock/PHP 8.2 jobs — override platform for Symfony 8 cells so resolution sees PHP >=8.4 (unset alone can still leave Composer on 8.2.x in some setups).
56-
if [ "${{ matrix.symfony }}" = "8.0" ]; then
57-
composer config platform.php "${{ matrix.php }}.99"
58-
fi
60+
case "${{ matrix.symfony }}" in
61+
8.*)
62+
composer config platform.php "${{ matrix.php }}.99"
63+
;;
64+
esac
5965
composer require symfony/config:^${{ matrix.symfony }} symfony/dependency-injection:^${{ matrix.symfony }} symfony/form:^${{ matrix.symfony }} symfony/framework-bundle:^${{ matrix.symfony }} symfony/http-foundation:^${{ matrix.symfony }} symfony/http-kernel:^${{ matrix.symfony }} symfony/routing:^${{ matrix.symfony }} symfony/twig-bundle:^${{ matrix.symfony }} symfony/web-profiler-bundle:^${{ matrix.symfony }} --no-interaction --no-update
6066
composer update symfony/* --with-all-dependencies --no-interaction --prefer-dist --no-progress
6167

Makefile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,3 +103,7 @@ update: ensure-up
103103

104104
validate: ensure-up
105105
$(COMPOSE) exec -T $(SERVICE_PHP) composer validate --strict
106+
107+
# REQ-MAKE-008: update-deps (REQ-MAKE-008)
108+
BUNDLE_ROOT := $(abspath $(dir $(lastword $(MAKEFILE_LIST))))
109+
include $(BUNDLE_ROOT)/../.scripts/Makefile.update-deps.mk

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# CKEditor 5 Editor Bundle
22

3-
[![CI](https://github.com/nowo-tech/Ckeditor5EditorBundle/actions/workflows/ci.yml/badge.svg)](https://github.com/nowo-tech/Ckeditor5EditorBundle/actions/workflows/ci.yml) [![Packagist Version](https://img.shields.io/packagist/v/nowo-tech/ckeditor5-editor-bundle.svg?style=flat)](https://packagist.org/packages/nowo-tech/ckeditor5-editor-bundle) [![Packagist Downloads](https://img.shields.io/packagist/dt/nowo-tech/ckeditor5-editor-bundle.svg)](https://packagist.org/packages/nowo-tech/ckeditor5-editor-bundle) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) [![PHP](https://img.shields.io/badge/PHP-8.2%2B-777BB4?logo=php)](https://php.net) [![Symfony](https://img.shields.io/badge/Symfony-6.4%20%7C%207%20%7C%208-000000?logo=symfony)](https://symfony.com) [![GitHub stars](https://img.shields.io/github/stars/nowo-tech/Ckeditor5EditorBundle.svg?style=social&label=Star)](https://github.com/nowo-tech/Ckeditor5EditorBundle) [![Coverage](https://img.shields.io/badge/Coverage-target%20100%25%20PHP-brightgreen)](#tests-and-coverage)
3+
[![CI](https://github.com/nowo-tech/Ckeditor5EditorBundle/actions/workflows/ci.yml/badge.svg)](https://github.com/nowo-tech/Ckeditor5EditorBundle/actions/workflows/ci.yml) [![Packagist Version](https://img.shields.io/packagist/v/nowo-tech/ckeditor5-editor-bundle.svg?style=flat)](https://packagist.org/packages/nowo-tech/ckeditor5-editor-bundle) [![Packagist Downloads](https://img.shields.io/packagist/dt/nowo-tech/ckeditor5-editor-bundle.svg)](https://packagist.org/packages/nowo-tech/ckeditor5-editor-bundle) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) [![PHP](https://img.shields.io/badge/PHP-8.2%2B-777BB4?logo=php)](https://php.net) [![Symfony](https://img.shields.io/badge/Symfony-6.4%20%7C%207.4%2B%20%7C%208.0%20%7C%208.1%2B-000000?logo=symfony)](https://symfony.com) [![Coverage](https://img.shields.io/badge/Coverage-target%20100%25%20PHP-brightgreen)](#tests-and-coverage)
44

55
> **Found this useful?** [Install from Packagist](https://packagist.org/packages/nowo-tech/ckeditor5-editor-bundle) · Star the repo on [GitHub](https://github.com/nowo-tech/Ckeditor5EditorBundle).
66
@@ -15,7 +15,16 @@ Symfony bundle: **`Ckeditor5EditorType`** stores HTML in a textarea while **CKEd
1515
- `nowo_ckeditor5_editor_asset_path()` Twig helper for published assets.
1616
- **pnpm + Vite** frontend; **Vitest** coverage on shared utilities (`logger.ts`).
1717
- **Dockerfile + Makefile** aligned with other Nowo bundles.
18-
- **Demos**: Symfony 7 & 8 under `demo/` (FrankenPHP).
18+
- **Demos**: Symfony **7.4** and **8.1** FrankenPHP apps under `demo/` (ports **8020** / **8021**).
19+
20+
## Requirements
21+
22+
| Symfony | PHP (minimum) | Notes |
23+
| ------- | ------------- | ----- |
24+
| **6.4**, **7.x** (incl. **7.4**) | **8.2+** | Tested in CI on **7.0** and **7.4** |
25+
| **8.0**, **8.1** | **8.4+** | Symfony 8 requirement; tested in CI on **8.0** and **8.1** |
26+
27+
Composer constraints: `^6.4 \|\| ^7.0 \|\| ^8.0` on Symfony components. See [INSTALLATION.md](docs/INSTALLATION.md).
1928

2029
## Quick start
2130

@@ -61,6 +70,7 @@ $builder->add('body', Ckeditor5EditorType::class, [
6170
- [Release](docs/RELEASE.md)
6271
- [Security](docs/SECURITY.md)
6372
- [Engram](docs/ENGRAM.md)
73+
- [Spec-driven development](docs/SPEC-DRIVEN-DEVELOPMENT.md)
6474

6575
### Additional documentation
6676

@@ -94,7 +104,7 @@ Presets include **`standard`**, **`simple`**, **`minimal`**, **`emoji`**, **`typ
94104
| **PHP** | **100%** statement coverage on bundle `src/` (PHPUnit + Clover); enforced by `scripts/verify-clover-100.php`. Run `composer test-coverage` or `make test-coverage`. |
95105
| **TypeScript** | Vitest thresholds on `src/Resources/assets/src/logger.ts` (see `vitest.config.ts`). Run `pnpm run test:coverage` or `make test-ts`. |
96106

97-
CI runs PHPUnit (matrix PHP × Symfony), PHPStan, PHP-CS-Fixer dry-run, and Vitest coverage on pushes and pull requests.
107+
CI runs PHPUnit (matrix **PHP 8.2–8.5** × **Symfony 7.0 / 7.4 / 8.0 / 8.1**), PHPStan, PHP-CS-Fixer dry-run, and Vitest coverage on pushes and pull requests.
98108

99109
## License
100110

0 commit comments

Comments
 (0)