t3docs/blog-example

This extension contains code examples used in TYPO3 explained to describe the use of Extbase.

12.0.4 2023-09-16 16:01 UTC

Requires

• typo3/cms-core: ^12.4
• typo3/cms-extbase: ^12.4
• typo3/cms-fluid: ^12.4

Requires (Dev)

• ergebnis/composer-normalize: ^2.28
• typo3/coding-standards: ^0.5.5

Replaces

• friendsoftypo3/blog-example: 12.0.4

GPL-2.0-or-later

• TYPO3 Documentation Team and contributors

README

TYPO3 extension blog_example

Installation: Can be installed via Composer: composer req t3docs/blog-example

This example provides the code examples for [Extbase reference] (https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ExtensionArchitecture/Extbase/Reference/Index.html#extbase-reference) of the TYPO3 project.

The code examples are automatically extracted with the TYPO3 documentation code-snippet tool (https://github.com/TYPO3-Documentation/t3docs-codesnippets)

After changes to the code the snippets in the TYPO3-Reference-CoreApi have to be regenerated.

ddev exec vendor/bin/typo3  restructured_api_tools:php_domain public/fileadmin/TYPO3CMS-Reference-CoreApi/Documentation/CodeSnippets/

It was originally written by Sebastian Kurfuerst and Jochen Rau (Thanks!) and adjusted over time to reflect current development in the TYPO3 project.

	URL
Repository:	https://github.com/TYPO3-Documentation/blog_example
TER:	https://extensions.typo3.org/extension/blog_example/

Running tests

The blog-example comes with a simple demo set of tests. It relies on the runTests.sh script which is a simplified version of a similar script from the TYPO3 core. Find detailed usage examples by executing Build/Scripts/runTests.sh -h and have a look at .github/workflows/tests.yml to see how this is used in CI.

Example usage:

Build/Scripts/runTests.sh -s composerUpdate
Build/Scripts/runTests.sh -s unit

Running some tests locally can fix errors that are just displayed in actions on github. The following command can fix things like linebreaks or indentations:

Build/Scripts/runTests.sh -s cgl

Normalize composer.json

Build/Scripts/runTests.sh -s composerNormalize -n

Tagging and releasing

packagist.org is enabled via the casual github hook. TER releases are created by the "publish.yml" github workflow when tagging versions. The commit message of the tagged commit is used as TER upload comment.