Document the removal of API compatibility (#299)
authorTim Düsterhus <duesterhus@woltlab.com>
Fri, 2 Sep 2022 11:31:06 +0000 (13:31 +0200)
committerGitHub <noreply@github.com>
Fri, 2 Sep 2022 11:31:06 +0000 (13:31 +0200)
Resolves #298

docs/migration/wsc55/deprecations_removals.md
docs/migration/wsc55/php.md

index 07c380fd0e57efcd1ebd14ee2995d2601d5233b9..4d4889714a21bf1eb01e7750b708a8ccb217613d 100644 (file)
@@ -129,6 +129,7 @@ With version 6.0, we have deprecated certain components and removed several othe
 - `wcf\system\search\elasticsearch\ElasticsearchHandler::PUT`
 - `SECURITY_TOKEN` ([WoltLab/WCF#4934](https://github.com/WoltLab/WCF/pull/4934))
 - `SECURITY_TOKEN_INPUT_TAG` ([WoltLab/WCF#4934](https://github.com/WoltLab/WCF/pull/4934))
+- `WSC_API_VERSION` ([WoltLab/WCF#4943](https://github.com/WoltLab/WCF/pull/4943))
 
 #### Options
 
@@ -196,6 +197,7 @@ With version 6.0, we have deprecated certain components and removed several othe
 - `WCF.Conversation.MarkAsRead`
 - `WCF.Conversation.MarkAllAsRead`
 - `WCF.ModeratedUserGroup.AddMembers`
+- `WSC_API_VERSION` ([WoltLab/WCF#4943](https://github.com/WoltLab/WCF/pull/4943))
 
 ### Database
 
index aaf434e71ce87477ef88806c62da38fcf7bfa0df..5c7e74d1ddb3010aaf6beac060a580003cfc9792 100644 (file)
@@ -11,6 +11,15 @@ The minimum requirements have been increased to the following:
 It is recommended to make use of the newly introduced features whereever possible.
 Please refer to the PHP documentation for details.
 
+## Package System
+
+### Removal of API compatibility
+
+WoltLab Suite 6.0 removes support for the deprecated API compatibility functionality.
+Any packages with a `<compatibility>` tag in their package.xml are assumed to not have been updated for WoltLab Suite 6.0 and will be rejected during installation.
+Furthermore any packages without an explicit requirement for `com.woltlab.wcf` in at least version `5.4.22` are also assumed to not have been updated for WoltLab Suite 6.0 and will also be rejected.
+The latter check is intended to reject old and most likely incompatible packages where the author forgot to add either an `<excludedpackage>` or a `<compatibility>` tag before releasing it.
+
 ## Indicating parameters that hold sensitive information
 
 PHP 8.2 adds native support for redacting parameters holding sensitive information in stack traces.