Skip to content

Commit

Permalink
[MAINTENANCE] Prepare Release 5.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastian-meyer committed Nov 7, 2024
1 parent ab8a8cc commit 9727d0a
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 124 deletions.
49 changes: 5 additions & 44 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,11 @@
# Development

## Kitodo.Presentation 4.0

- In Extbase, there is a default naming scheme to map model names to database
table names. As we currently don't use these for historic reasons, the mapping
needs to be reconfigured:

- [ext_typoscript_setup.txt](ext_typoscript_setup.txt) is for compatibility
with TYPO3 v9.
- [Classes.php](Configuration/Extbase/Persistence/Classes.php) is for TYPO3
v10 onwards.
- `polyfillExtbaseClassesForTYPO3v9` (defined in [Helper.php](Classes/Common/Helper.php))
is used for TYPO3 v9 compatibility with the expression language function
`getDocumentType()` ([DocumentTypeFunctionProvider.php](Classes/ExpressionLanguage/DocumentTypeFunctionProvider.php)).

To simplify this, we may consider to rename database tables according to the
default naming scheme.


## Future Changes

### TCA type "language"
The TCA field 'sys_language_uid' of table 'tx_dlf_collections' is defined as the 'languageField' and should therefore use the TCA type 'language' instead of TCA type 'select' with 'foreign_table=sys_language' or 'special=languages'.

### Forward() in controller actions will be removed in TYPO3 12

Instead of calling $this->forward() the controller action must return a ForwardResponse

https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/11.0/Deprecation-92815-ActionControllerForward.html

### Pagination Widget will be removed in TYPO3 11

https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/11.0/Breaking-92529-AllFluidWidgetFunctionalityRemoved.html

The current solution does only work with TYPO3 9 and 10.

As of TYPO3 10 a new pagination API has been introduced. This could be used as replacement in a release supporting TYPO3 10 and 11.

https://docs.typo3.org/m/typo3/reference-coreapi/10.4/en-us/ApiOverview/Pagination/Index.html

## Testing

Before running any of the tests, please install the project dependencies. Choose which version of TYPO3 you would like to test against.

```bash
# If you use PHP 7.3 or 7.4 (supported by Kitodo)
# If you use PHP 7.4 (supported by Kitodo)
composer update --with=typo3/cms-core:^10.4

# If you use PHP 8
Expand All @@ -60,7 +21,7 @@ composer test

# Run specific kind of tests
composer test:unit
composer test:unit:local # Run using locally installed PHP
composer test:unit:local # Run using locally installed PHP
composer test:func

# Run tests in watch mode
Expand All @@ -78,14 +39,14 @@ vendor/bin/phpunit -c Build/Test/UnitTests.xml

# Run in Docker
Build/Test/runTests.sh
Build/Test/runTests.sh -w # Watch mode
Build/Test/runTests.sh -w # Watch mode
```

Functional tests may only be run in Docker as they require more infrastructure to be set up.

```bash
Build/Test/runTests.sh -s functional
Build/Test/runTests.sh -s functional -w # Watch mode
Build/Test/runTests.sh -s functional -w # Watch mode
```

To learn about available options (e.g., to select the PHP version), check the usage info:
Expand All @@ -98,7 +59,7 @@ You may also interact with the Docker containers directly:

```bash
cd Build/Test/
vim .env # Edit configuration
vim .env # Edit configuration
docker compose run unit
docker compose run functional
docker compose down
Expand Down
2 changes: 1 addition & 1 deletion Documentation/guides.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<guides xmlns="https://www.phpdoc.org/guides" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="https://www.phpdoc.org/guides ../vendor/phpdocumentor/guides-cli/resources/schema/guides.xsd" links-are-relative="true">
<extension class="\T3Docs\Typo3DocsTheme\DependencyInjection\Typo3DocsThemeExtension" project-home="https://kitodo.org" project-contact="mailto:[email protected]" project-repository="https://github.com/kitodo/kitodo-presentation" project-issues="https://github.com/kitodo/kitodo-presentation/issues" edit-on-github-branch="master" edit-on-github="kitodo/kitodo-presentation" typo3-core-preferred="stable"/>
<project title="Kitodo.Presentation" release="5.0" copyright="since 2017 by Kitodo Release Management Team"/>
<project title="Kitodo.Presentation" release="5.1" copyright="since 2017 by Kitodo Release Management Team"/>
<inventory id="t3tsref" url="http://docs.typo3.org/typo3cms/TyposcriptReference/"/>
</guides>
2 changes: 1 addition & 1 deletion ext_emconf.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
$EM_CONF[$_EXTKEY] = [
'title' => 'Kitodo.Presentation',
'description' => 'Base plugins, modules, services and API of the Digital Library Framework. It is part of the community-based Kitodo Digitization Suite.',
'version' => '5.0.6',
'version' => '5.1.0',
'category' => 'misc',
'constraints' => [
'depends' => [
Expand Down
78 changes: 0 additions & 78 deletions ext_typoscript_setup.txt

This file was deleted.

0 comments on commit 9727d0a

Please sign in to comment.