[TASK] Deployment running Git pull and Composer (#5614)

linawolf · sarahmccarthy123 · web-flow · commit d086199d56ff · 2025-05-19T11:09:53.000+02:00
* [TASK] Deployment running Git pull and Composer

Releases:  main, 13.4, 12.4

* [TASK] Deployment running Git pull and Composer

Releases:  main, 13.4, 12.4

* [TASK] Deployment running Git pull and Composer

Releases:  main, 13.4, 12.4

* [TASK] Language checks

Releases: main

* Update Index.rst

---------

Co-authored-by: Sarah McCarthy &lt;sarahmccarthy123@yahoo.com&gt;
diff --git a/Documentation/Administration/Deployment/Tools/GitComposer/Index.rst b/Documentation/Administration/Deployment/Tools/GitComposer/Index.rst
@@ -0,0 +1,109 @@
+:navigation-title: Git and Composer
+
+..  include:: /Includes.rst.txt
+..  _deployment-git-composer:
+
+======================================
+Deploying TYPO3 Using Git and Composer
+======================================
+
+This guide describes how to deploy a TYPO3 project directly onto your server
+using **Git** and **Composer**, without the need for additional deployment tools.
+
+This method is **simple to set up** and **requires no external deployment services**,
+but it does require **Git and Composer to be installed on the server** and may cause
+**downtime during updates**.
+
+For a detailed comparison with other deployment methods, including **Deployer**
+and **rsync**, see section
+`Comparison of deployment methods <https://docs.typo3.org/permalink/t3coreapi:deployment-tools-comparision>`_.
+
+..  _deployment-git-composer-quick:
+
+Quick start: Deploy with Git and Composer
+=========================================
+
+Execute the following in the folder into which your project was originally
+:ref:`cloned <deployment-git-composer-clone>`. The folder must
+contain the :path:`.git` directory.
+
+..  code-block:: bash
+
+    cd /var/www/your-project
+    git pull
+    composer install --no-dev
+    vendor/bin/typo3 database:updateschema
+    vendor/bin/typo3 cache:flush
+
+This performs a basic update of your project code and dependencies in production
+mode.
+
+See also chapter `Finding or installing Composer on the server <https://docs.typo3.org/permalink/t3coreapi:direct-server-composer-access>`_.
+
+..  _deployment-git-composer-detailed:
+
+Detailed deployment instructions
+================================
+
+The following sections explain the deployment process step by step.
+
+Prerequisites:
+
+-   The TYPO3 project is under version control using Git. See chapter
+    `Version control of TYPO3 projects with Git <https://docs.typo3.org/permalink/t3coreapi:version-control>`_
+-   `TYPO3 was installed using Composer <https://docs.typo3.org/permalink/t3coreapi:installation-composer>`_
+-   The server has **PHP**, **Composer**, **Git**, and other required system packages installed.
+-   **Shell (SSH) access** to the server to run deployment commands.
+
+..  _deployment-git-composer-clone:
+
+Step 1: Clone or update the repository
+--------------------------------------
+
+**First-time setup:**
+
+..  code-block:: bash
+
+    git clone <your-git-repository-url> /var/www/your-project
+    cd /var/www/your-project
+
+**On subsequent deployments:**
+
+..  code-block:: bash
+
+    cd /var/www/your-project
+    git pull
+
+..  _deployment-git-composer-install:
+
+Step 2: Install production dependencies
+---------------------------------------
+
+Install only production-relevant packages by running:
+
+..  code-block:: bash
+
+    composer install --no-dev --ignore-platform-reqs
+
+Parameter `--no-dev` excludes development packages. If the PHP version running
+on the console and the PHP version running on the server differ, you may need 
+to use `--ignore-platform-reqs` to skip platform checks.
+
+..  _deployment-git-composer-commands:
+
+Step 3: Run TYPO3 maintenance commands
+--------------------------------------
+
+Apply database schema updates if required:
+
+..  code-block:: bash
+
+    vendor/bin/typo3 database:updateschema
+
+Clear TYPO3 caches:
+
+..  code-block:: bash
+
+    vendor/bin/typo3 cache:flush
+
+Optional: Run project-specific tasks as needed.
diff --git a/Documentation/Administration/Deployment/Tools/Index.rst b/Documentation/Administration/Deployment/Tools/Index.rst
@@ -7,24 +7,99 @@
 Deployment tools
 ================
 
-The following tools can be used to deploy TYPO3 manually or automatically
-in a :abbr:`CI (Continuos Integration)` pipeline.
+The following tools can be used to deploy TYPO3 either manually or in an automated
+:abbr:`CI (Continuos Integration)` pipeline.
 
 ..  toctree::
     :titlesonly:
 
     Rsync/Index
     Deployer/Index
+    GitComposer/Index
     */Index
 
+..  _deployment-tools-comparision:
+
+Comparison of deployment tools
+==============================
+
+..  t3-field-list-table::
+    :header-rows: 1
+
+    -   :Method: Method
+        :Pros: Pros
+        :Cons: Cons
+        :Typical Use Cases: Typical Use Cases
+
+    -   :Method: Git + Composer
+        :Pros:
+            - Simple setup
+            - No extra tooling needed
+            - Version control on server
+        :Cons:
+            - Composer and Git must be installed on production server
+            - Possible downtime during install
+            - Risk of untracked local changes on server
+            - Deployment may fail if external package sources are temporarily unavailable
+        :Typical Use Cases:
+            - Small to medium projects
+            - Developers familiar with CLI
+            - Environments without CI/CD tooling
+
+    -   :Method: Deployer
+        :Pros:
+            - Atomic deployment with rollback
+            - Zero-downtime deployments
+            - Keeps release history
+        :Cons:
+            - Additional tool to learn and configure
+            - Deployment process might be too complex for beginners
+        :Typical Use Cases:
+            - Professional production environments
+            - Teams with CI/CD pipelines
+            - Projects requiring rollback capabilities
+
+    -   :Method: Manual rsync
+        :Pros:
+            - No requirement for Composer/Git
+            - Simple file transfer
+        :Cons:
+            - Requires staging/build environment
+            - Risk of partial updates if interrupted
+            - No version tracking on the server
+        :Typical Use Cases:
+            - Static file transfer or legacy systems
+            - Environments without PHP/Composer tooling on production
+
+    -   :Method: No Deployment (Direct Installation on Server)
+        :Pros:
+            - No deployment tooling required
+            - Easy to get started for single updates
+        :Cons:
+            - No version control or rollback possible
+            - High risk of human error
+            - No automation, no reproducibility
+        :Typical Use Cases:
+            - Very small or legacy projects
+            - One-time manual updates
+            - Not recommended for professional environments
+
+..  rubric:: Summary:
+
+-   **Git + Composer**: Easy but requires server-side tooling.
+-   **Deployer**: Advanced, safe, and rollback-friendly but requires extra setup.
+-   **Manual rsync**: Simple file sync, but requires external build or packaging steps.
+-   **No Deployment (Direct Installation on Server**): Easy to get started, but risky, untracked, and not recommended for professional environments.
+
+Select the method that best suits your workflow and server capabilities.
+
 ..  _deployment-magallanes:
 ..  _deployment-typo3-surf:
 
 Other deployment tools
 ======================
 
-*   :doc:`TYPO3 Surf <ext_surf:Index>` was used as a deployment tool
-    specialized on TYPO3. It has mostly been succeeded by
-    `Deployer <https://docs.typo3.org/permalink/t3coreapi:deployment-deployer>`_
-    however.
+*   :doc:`TYPO3 Surf <ext_surf:Index>` was formerly commonly used as a TYPO3 deployment tool.
+    It has now mostly been succeeded by
+    `Deployer <https://docs.typo3.org/permalink/t3coreapi:deployment-deployer>`_.
 *   Another deployment tool for PHP applications written in PHP: https://www.magephp.com/
