KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #typescript #claude-code #codex #dsh #dsh-plugin #ai-agent #ai-agents #deepseek-harness #agent-skills #macos #cli

phalcon-ci-installer

★ 26 Open GitHub ↗

Composer integration for PHP applications to install the Phalcon framework as an extension in the PHP runtime for various hosted CI services including TravisCI, CircleCI, ScrutinizerCI, Shippable and Codeship.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Phalcon CI Installer

[![CircleCI](https://img.shields.io/circleci/token/e0f3c984c936d88ad20ca9db4112f032d27930af/project/techpivot/phalcon-ci-installer/master.svg?label=circleci&style=flat-square)](https://circleci.com/gh/techpivot/phalcon-ci-installer)
[![Travis CI](https://img.shields.io/travis/techpivot/phalcon-ci-installer/master.svg?label=travisci&style=flat-square)](https://travis-ci.org/techpivot/phalcon-ci-installer)
[![Scrutinizer](https://img.shields.io/scrutinizer/build/g/filp/whoops.svg?label=scrutinizer&style=flat-square)](https://scrutinizer-ci.com/g/techpivot/phalcon-ci-installer/)
[![Codeship](https://img.shields.io/codeship/546abfd0-3037-0134-bd3d-7603af744759/master.svg?label=codeship&style=flat-square)](https://codeship.com/projects/109153)
[![Shippable](https://img.shields.io/shippable/56204d941895ca44741e1583/master.svg?label=shippable&style=flat-square)](https://app.shippable.com/projects/56204d941895ca44741e1583)

[![Latest Version](https://img.shields.io/packagist/v/techpivot/phalcon-ci-installer.svg?style=flat-square)](https://packagist.org/packages/techpivot/phalcon-ci-installer)
[![Total Downloads](https://img.shields.io/packagist/dt/techpivot/phalcon-ci-installer.svg?style=flat-square)](https://packagist.org/packages/techpivot/phalcon-ci-installer)
[![Software License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://raw.githubusercontent.com/techpivot/phalcon-ci-installer/master/LICENSE)

Composer integration for PHP applications to install the [Phalcon](https://phalconphp.com) framework as an extension in the PHP runtime for various hosted CI services including CircleCI, Travis CI, Scrutinizer, Codeship, and Shippable.

## Features
* Phalcon extension loaded in PHP runtime
* Native cache support to prevent rebuilding Phalcon from source
* Auto-detection of latest tagged Phalcon version
* Install specific Phalcon versions, tags and releases _(Since 1.0.2)_
* Supports PHP7 and Phalcon 3.0.x _(Since 1.0.4)_

## Version Compatibility

The following table outlines general compability of Phalcon inside various CI environments.

| PHP CI Version | Phalcon Version(s) | CI Environment |
|:---------------|:-------------------|:---------------|
| 5.3            | ✖   (Not supported)            | - |
| 5.4            | ✖   (Not supported)            | - |
| 5.5            | ✔   `master`, `2.0.x`, `3.0.x` | ✔ CircleCI, Travis CI, Scrutinizer, Codeship, Shippable |
| 5.6            | ✔   `master`, `2.0.x`, `3.0.x` | ✔ CircleCI, Travis CI, Scrutinizer, Codeship, Shippable |
| 7.0            | ✔   `3.0.x`                    | ✔ CircleCI, Travis CI, Scrutinizer, Codeship, Shippable |

## Installation

1. Add the `techpivot/phalcon-ci-installer` repository into the **require-dev** section of your `composer.json` as follows:

```json
    "require-dev": {
        "techpivot/phalcon-ci-installer": "~1.0"
    }
  ```
1. Update your CI script to execute the **vendor/bin/install-phalcon.sh** installer in the 
relevant section. See the examples below for various CI providers.

## Options

The installer takes one optional argument that can be used to specify a specific branch or tag.

Examples:

```bash
# Install latest version from default branch
vendor/bin/install-phalcon.sh

# Install latest revision from branch "3.0.x"
vendor/bin/install-phalcon.sh 3.0.x

# Install specific release tag "phalcon-v2.0.9"
vendor/bin/install-phalcon.sh phalcon-v2.0.9
```

> **Note:** The Phalcon CI installer is designed to cache the resulting binaries that correspond to the Phalcon/PHP version. 
Specifing a release or tagged version will result in the best performance as subsequent builds (depending on CI 
container/settings)  will be cached. Building from a branch (including the default master option) will result in a 
Phalcon rebuild every time the installer detects a new version that is not yet cached.

## CI Environments

### CircleCI

**`circle.yml`**
```yml
machine:
  php:
    version: 5.6.14

dependencies:
  cache_directories:
    - vendor
    - ~/cphalcon

post:
    - vendor/bin/install-phalcon.sh phalcon-v2.0.13

test:
  override:
    - vendor/bin/phpunit
```

> **Note:** In order to cache data for faster builds, ensure the `cache_directories` directives are specified as outlined above.

> **Note:** Ensure that the `vendor/bin/circleci-install-phalcon.sh` is executed in the **post** phase, which will allow for the inclusion of the `techpivot/phalcon-ci-installer` repository during the composer installation at inference or override phase.

> **Reference:** CircleCI PHP Versions – [Ubuntu 14.04](https://circleci.com/docs/build-image-trusty/#php) • [Ubuntu 12.04](https://circleci.com/docs/build-image-precise/#php)

### Travis CI

**`.travis.yml`**
```yml
language: php

php:
  - 5.5
  - 5.6
  - 7.0

cache:
  directories:
    - vendor
    - ~/.composer/cache
    - ~/cphalcon

before_install:
  - composer install --prefer-source --no-interaction
  - vendor/bin/install-phalcon.sh 3.0.x

script:
  - vendor/bin/phpunit

notifications:
  email: false
```

> **Note:** Multiple PHP versions can be specified and each one will be cached independently; however, the phalcon target ref (branch or tag) will be applied for all builds

> **Reference:** [TravisCI PHP Versions](https://docs.travis-ci.com/user/languages/php#Choosing-PHP-versions-to-test-against)

### Scrutinizer

**`.scrutinizer.yml`**
```yml
build:
    environment:
        php:
            version: 7.0.8

cache:
        directories:
            - ~/cphalcon

dependencies:
        override:
            - composer install --prefer-source --no-interaction
        after: 
            - vendor/bin/install-phalcon.sh 3.0.x
```

> **Note:** No need to include the `vendor/` cache directory as this is cached automatically.

> **Reference:** [ScrutinizerCI PHP Versions](https://scrutinizer-ci.com/docs/configuration/build#php)

### Codeship
Sample **Setup Commands**

```bash
phpenv local 5.6
php --version
composer install --prefer-source --no-interaction
vendor/bin/install-phalcon.sh
```

> **Reference:** [Codeship CI PHP Versions](https://codeship.com/documentation/languages/php/#versions)

### Shippable

**`shippable.yml`**
```yml
language: php
php:
  - 7.0

build:
  cache: true
    
  cache_dir_list:
    - $SHIPPABLE_BUILD_DIR/vendor
    - ~/cphalcon

ci:
    - composer install --prefer-source --no-interaction
    - bin/install-phalcon.sh 3.0.x
```

> **Reference:** [Shippable PHP Versions](http://docs.shippable.com/ci_languages/#php)

phalcon-ci-installer

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README