github/directus
1
1
Fork 0
mirror of https://github.com/directus/directus.git synced 2026-04-25 03:00:53 -04:00
Code Issues Packages Projects Releases Wiki Activity

Clarified that extension type subdirectories must be removed (#21696)

Browse Source 
* Clarified that extension type subdirectories must be removed

* Update docs/releases/breaking-changes.md

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>

* Improve language on extensions type breaking change

* Add changeset

---------

Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com>
This commit is contained in:
Kevin Lewis
2024-03-05 21:34:32 +01:00
committed by GitHub
parent 508508d687
commit d12b7c9033
2 changed files with 14 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
.changeset/four-dingos-press.md Normal file
View File

@@ -0,0 +1,5 @@
---
'docs': patch
---
Updated breaking change note on the typed extension folders

14
docs/releases/breaking-changes.md
View File

@@ -15,13 +15,17 @@ Starting with Directus 10.0, here is a list of potential breaking changes with r
## Version 10.10.0
### Removed Local Extension Folders
### Deprecated Typed Extension Folders
Legacy extension type directory-based structure (/interfaces/my-interface/, /endpoints/my-endpoint, etc) are being
Legacy extension type directory-based structure (`/interfaces/my-interface/`, `/endpoints/my-endpoint`, etc) are being
removed in favor of relying on the `package.json` file for metadata including extension type.
If your extension is already in the root `extensions` directory and has a `package.json` file with a
`directus:extension` object, there is no action required.
If your extensions are already relying on the up-to-date extensions folder paradigm (extensions in the root of your
extensions folder prefixed with `directus-extension-`) no action is required at this point. If you're currently relying
on the legacy format for extensions, recognizable by each extension type having it's own folder, like `endpoints`,
`hooks`, etc, you will have to update your extensions before upgrading to this version.
Directus will ignore extensions altogether if the extensions folder contains the legacy typed folders starting in 10.10.
::: details Migration/Mitigation
@@ -30,7 +34,7 @@ Move all extension directories from their extension type subdirectory one level
- `./extensions/modules/module-a/` becomes `./extensions/module-a/`.
- `./extensions/panels/panel-b/` becomes `./extensions/panel-b/`.
If your project does not already have one, add a `directus:extension` object to your `package.json` file:
If your extension does not already have one, add a `directus:extension` object to your `package.json` file:
```json
{