mirror of
https://github.com/FriendsOfTYPO3/tea.git
synced 2024-12-23 18:26:11 +01:00
fc5b861bcd
See c2bb63bead for further details.
The README.md should mostly only cover the abstract and links.
The composer commands are the core value of this extension. List
all commands in the documentation and copy the descriptions from
the `composer.json`. This lets the global search at docs.typo3.org
find these commands.
Remove superfluous Linters page, which is integrated now in the
Running page.
Use sentence case in page titles in order to conform to the
TYPO3 documentation standards.
The ambiguous :ts: text role has been removed to
not confuse the writer with typescript and typoscript.
Add the common extension destinations to `composer.json`.
(Packagist displays them in a prominent place.)
46 lines
1.6 KiB
ReStructuredText
46 lines
1.6 KiB
ReStructuredText
.. include:: /Includes.rst.txt
|
|
|
|
.. _continuous-integration:
|
|
|
|
======================
|
|
Continuous integration
|
|
======================
|
|
|
|
As an example, this extension provides several ways to perform the code quality
|
|
checks and tests in a CI pipeline. You can copy the
|
|
appropriate configuration depending on which Git hosting service and CI
|
|
platform you want to use.
|
|
|
|
.. contents:: Table of Contents:
|
|
:backlinks: top
|
|
:class: compact-list
|
|
:depth: 2
|
|
:local:
|
|
|
|
.. _github-actions:
|
|
|
|
GitHub Actions
|
|
==============
|
|
|
|
This extension has two code-checking workflows for
|
|
`GitHub Actions <https://github.com/TYPO3-Documentation/tea/actions>`__:
|
|
|
|
- `one that uses the local tools <https://github.com/TYPO3-Documentation/tea/blob/main/.github/workflows/ci.yml>`__:
|
|
This is the workflow you most probably would want to use:
|
|
This workflow uses the development tools installed via Composer and PHIVE and
|
|
calls them using the provided Composer scripts. Use this workflow if you want
|
|
to run the code quality checks locally as well as in GitHub Actions.
|
|
|
|
- `one that completely relies on predefined actions <https://github.com/TYPO3-Documentation/tea/blob/main/.github/workflows/predefined.yml>`__:
|
|
This workflow does not need the development tools to be installed locally.
|
|
Use this workflow if you only want to run the code quality checks in GitHub
|
|
Actions, but not locally.
|
|
|
|
.. _gitlab-ci:
|
|
|
|
GitLab CI
|
|
=========
|
|
|
|
This extension also provides
|
|
`configuration <https://github.com/TYPO3-Documentation/tea/blob/main/.gitlab/pipeline/.gitlab-ci.yml>`__
|
|
for `GitLab CI <https://gitlab.typo3.org/qa/example-extension/-/pipelines>`__.
|