Skip to content

Commit 47a7501

Browse files
authored
Docs: Add version header and What's New section (#1019)
Adds "5.x" to the main documentation title and a prominent "What's New in 5.x" section highlighting key features. This helps users understand which version the documentation covers, reducing confusion when following v5-specific features while using v4.x. Refs #1018
1 parent 6d5a3df commit 47a7501

1 file changed

Lines changed: 17 additions & 2 deletions

File tree

docs/en/index.rst

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Migrations
2-
##########
1+
Migrations 5.x
2+
##############
33

44
Migrations is a plugin that lets you track changes to your database schema over
55
time as PHP code that accompanies your application. This lets you ensure each
@@ -9,6 +9,21 @@ migrations.
99
Instead of writing schema modifications in SQL, this plugin allows you to
1010
define schema changes with a high-level database portable API.
1111

12+
What's New in 5.x
13+
=================
14+
15+
Migrations 5.x includes several new features:
16+
17+
- **Seed tracking** - Seeds are now tracked in a ``cake_seeds`` table, preventing
18+
accidental re-runs
19+
- **Check constraints** - Support for database check constraints via ``addCheckConstraint()``
20+
- **Default values in bake** - Specify default values when baking migrations
21+
(e.g., ``active:boolean:default[true]``)
22+
- **MySQL ALTER options** - Control ``ALGORITHM`` and ``LOCK`` for ALTER TABLE operations
23+
- **insertOrSkip()** - New method for idempotent seed data insertion
24+
25+
See the :doc:`upgrading` guide for breaking changes and migration steps from 4.x.
26+
1227
Installation
1328
============
1429

0 commit comments

Comments
 (0)