docs: prepare 5.x release

nelmio · Jan 19, 2025 · d88b8b6 · d88b8b6
1 parent 6b09469
commit d88b8b6
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 10 deletions.
diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml
@@ -7,11 +7,9 @@ on:
   pull_request:
     branches:
       - "*.x"
-      - master
   push:
     branches:
       - "*.x"
-      - master
 
 env:
   fail-fast: true

diff --git a/.symfony.bundle.yaml b/.symfony.bundle.yaml
@@ -1,6 +1,5 @@
-branches: ["2.x", "3.x", "master", "5.x"]
-maintained_branches: ["master", "5.x"]
-current_branch: "master"
-master_alias: "4.x"
+branches: ["2.x", "3.x", "4.x", "5.x"]
+maintained_branches: ["4.x", "5.x"]
+current_branch: "5.x"
 dev_branch: "5.x"
-doc_dir: { "3.x": "Resources/doc/", "master": "docs/", "5.x": "docs/" }
+doc_dir: { "3.x": "Resources/doc/", "4.x": "docs/", "5.x": "docs/" }
diff --git a/README.md b/README.md
@@ -9,15 +9,25 @@ Version](https://poser.pugx.org/nelmio/api-doc-bundle/v/stable)](https://packagi
 The **NelmioApiDocBundle** bundle allows you to generate a decent documentation
 for your APIs.
 
+## Migrate from 4.x to 5.0
+
+[To migrate from 4.x to 5.0, follow our guide.](https://github.com/nelmio/NelmioApiDocBundle/blob/5.x/UPGRADE-5.0.md)
+
+This version comes with the following major changes:
+- The bundle now requires PHP 8.1 or higher.
+- Support for annotations has been removed in favor of PHP 8 attributes.
+- Minimum Symfony version is now 6.4.
+- Major cleanup and simplification of the codebase.
+
 ## Migrate from 3.x to 4.0
 
-[To migrate from 3.x to 4.0, follow our guide.](https://github.com/nelmio/NelmioApiDocBundle/blob/master/UPGRADE-4.0.md)
+[To migrate from 3.x to 4.0, follow our guide.](https://github.com/nelmio/NelmioApiDocBundle/blob/5.x/UPGRADE-4.0.md)
 
 Version 4.0 brings OpenAPI 3.0 support. If you want to stick to Swagger 2.0, you should use the version 3 of this bundle.
 
 ## Migrate from 2.x to 3.0
 
-[To migrate from 2.x to 3.0, follow our guide.](https://github.com/nelmio/NelmioApiDocBundle/blob/master/UPGRADE-3.0.md)
+[To migrate from 2.x to 3.0, follow our guide.](https://github.com/nelmio/NelmioApiDocBundle/blob/5.x/UPGRADE-3.0.md)
 
 ## Installation
 

diff --git a/composer.json b/composer.json
@@ -91,7 +91,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "4.x-dev",
+            "dev-4.x": "4.x-dev",
             "dev-5.x": "5.x-dev"
         }
     },