Add new job Composer_install

## Objective

This job installs `composer` dependencies listed in your `composer.lock` or `composer.json` and exposes the folder

`vendor` as cache to other jobs of your pipeline. It allows you to run

`composer install` only once in your pipeline.

## How to use it

!!! info

    If you don't have `composer.lock`, the job will look for `composer.json` and use it instead

1. Ensure that your project has

   [`composer.lock`](https://getcomposer.org/doc/01-basic-usage.md#installing-with-composer-lock){:target="_blank"}

   file which contains the dependencies and their exact versions

1. Add this job URL inside the `include` list of your `.gitlab-ci.yml` file (see the [quick setup](/use-the-hub/#quick-setup)). You can specify [a fixed version](#changelog) instead of `latest`.

    ```yaml

      - remote: 'https://jobs.r2devops.io/latest/composer_install.yml'

    ```

3. If you need to customize the job (stage, variables, ...) 👉 check the [jobs

   customization](/use-the-hub/#jobs-customization)

4. Well done, your job is ready to work ! 😀

## Job details

!!! info

    On Gitlab, this job will be run in the default first stage of your

    pipeline: [`.pre`](https://docs.gitlab.com/ee/ci/yaml/#pre-and-post)

    For this reason, using only this job in your pipeline will not trigger a pipeline in Gitlab.

    You have to add additional jobs.

* Job name: `composer_install`

* Default stage: [`.pre`](https://docs.gitlab.com/ee/ci/yaml/#pre-and-post){:target="_blank"}

* Docker image: [`edbizarro/gitlab-ci-pipeline-php:7.3`](https://hub.docker.com/_/node){:target="_blank"}

* When: `always`

### Variables

!!! note

    All paths defined in variables are relative and starts from the root of your

    repository.

| Name | Description | Default |

| ---- | ----------- | ------- |

| `PROJECT_ROOT` | Path to the directory containing `composer.lock`  | `.` |

| `COMPOSER_INSTALL_OPTIONS` | Additional options for `composer install` | ` ` |

### Cache

This job creates a global cache configuration. Regarding the configuration

applied, cache behavior is the following:

* Shared between all jobs and pipelines on the same branch

* Contains folder `$PROJECT_ROOT/vendor`

* If `composer install` produces different result than the cached content

More information on Gitlab caching mechanism in [Gitlab CI/CD caching

documentation](https://docs.gitlab.com/ee/ci/caching/index.html){:target="_blank"}.

# Job from R2Devops hub --> r2devops.io

cache:

  key:

    files:

      - "${PROJECT_ROOT}/composer.lock"

    prefix: "composer-${CI_COMMIT_REF_SLUG}"

  paths:

    - "${PROJECT_ROOT}/vendor"

  when: "on_success"

npm_install:

  stage: .pre

  image:

    name: edbizarro/gitlab-ci-pipeline-php:7.3

    entrypoint: [""]

  variables:

    PROJECT_ROOT: "."

    COMPOSER_INSTALL_OPTIONS: ""

  script:

    # Working directory

    - cd $PROJECT_ROOT

    # Run composer install

    - composer install $COMPOSER_INSTALL_OPTIONS

name: composer_install

description: A ready to use composer job that installs dependencies and exposes vendor as cache to other jobs

default_stage: others

icon: 🎷

maintainer: moha-s

license: MIT

images:

    "edbizarro/gitlab-ci-pipeline-php": "7.3"

tools:

labels:

    - GitLab

    - Utilities

    - Composer

 No newline at end of file

* Initial version