tea/Documentation/ContinuousIntegration.rst

.. 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/FriendsOfTYPO3/tea/actions>`__:

- `one that uses the local tools <https://github.com/FriendsOfTYPO3/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/FriendsOfTYPO3/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/FriendsOfTYPO3/tea/blob/main/.gitlab/pipeline/.gitlab-ci.yml>`__
for `GitLab CI <https://gitlab.typo3.org/qa/example-extension/-/pipelines>`__.
[TASK] Update docs (#404) See https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument/commit/c2bb63beadb7cc1ea6eb3496613c3376f970d4c9 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.) 2022-04-12 19:00:11 +02:00			`.. 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`
[TASK] Update repository urls (#946) Resolves: #895 Co-authored-by: Łukasz Uznański <l.uznanski@macopedia.com> 2023-10-08 21:53:41 +02:00			`GitHub Actions <https://github.com/FriendsOfTYPO3/tea/actions>`__:
[TASK] Update docs (#404) See https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument/commit/c2bb63beadb7cc1ea6eb3496613c3376f970d4c9 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.) 2022-04-12 19:00:11 +02:00
[TASK] Update repository urls (#946) Resolves: #895 Co-authored-by: Łukasz Uznański <l.uznanski@macopedia.com> 2023-10-08 21:53:41 +02:00			- `one that uses the local tools <https://github.com/FriendsOfTYPO3/tea/blob/main/.github/workflows/ci.yml>`__:
[TASK] Update docs (#404) See https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument/commit/c2bb63beadb7cc1ea6eb3496613c3376f970d4c9 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.) 2022-04-12 19:00:11 +02:00			`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.`

[TASK] Update repository urls (#946) Resolves: #895 Co-authored-by: Łukasz Uznański <l.uznanski@macopedia.com> 2023-10-08 21:53:41 +02:00			- `one that completely relies on predefined actions <https://github.com/FriendsOfTYPO3/tea/blob/main/.github/workflows/predefined.yml>`__:
[TASK] Update docs (#404) See https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument/commit/c2bb63beadb7cc1ea6eb3496613c3376f970d4c9 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.) 2022-04-12 19:00:11 +02:00			`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`
[TASK] Update repository urls (#946) Resolves: #895 Co-authored-by: Łukasz Uznański <l.uznanski@macopedia.com> 2023-10-08 21:53:41 +02:00			`configuration <https://github.com/FriendsOfTYPO3/tea/blob/main/.gitlab/pipeline/.gitlab-ci.yml>`__
[TASK] Update docs (#404) See https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument/commit/c2bb63beadb7cc1ea6eb3496613c3376f970d4c9 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.) 2022-04-12 19:00:11 +02:00			for `GitLab CI <https://gitlab.typo3.org/qa/example-extension/-/pipelines>`__.