Create a .phar file by onema · Pull Request #124 · php-coveralls/php-coveralls

onema · 2015-12-04T06:57:40Z

Objective:

This PR aims to add the basic files and configuration to create a coveralls.phar using the box-project. The .phar file can be build by travis and attached to a release when tagged.

The .phar can be downloaded by third party projects and used instead of requiring it as a dependency.

Summary of changes:

Moved coveralls CLI application out of the composer file into the bin file.
Simplified bin\coveralls file
Updates all paths in .travis.yml and compsoer.json
Added box.json file with configuration required to build phar using box-project

Building and deployment:

The coveralls.phar file can be build and deployed using travis every time a release is tagged by adding the following to the .travis.yml:

before_script:
  - curl -LSs http://box-project.github.io/box2/installer.php | php
  - mkdir -p build/artifacts
  # ...
before_deploy:
  - php composer.phar install --no-dev --no-interaction
  - php box.phar build
  - rm box.phar
deploy:
  provider: releases
  api_key:
    secure: AbCD...xYZ
  file: build/artifacts/coveralls.phar
  on:
    repo: CPCStrategy/oauth2-flow-runner
    tags: true
    all_branches: true
    php: 5.5

Notice that composer is run with the flag --no-dev to avoid including any require-dev dependencies.

See the travis deployment documentation for more information on how to securely add the API key to the deployment section

tmatsuo · 2015-12-04T07:31:17Z

@onema, At the first glance, it really looks promising! Thanks! Really appreciated :)
I'll review this in detail tomorrow.

tmatsuo · 2015-12-04T07:37:10Z

.gitignore

Why are you removing build dir?

You are right, there is no need to remove the build from.gitignore. Will fix

tmatsuo · 2015-12-04T07:55:26Z

@onema, also thanks for the great description. This is super helpful.

Notice that composer is run with the flag --no-dev to avoid including any require-dev dependencies.

Does this mean we need to clean up the vendor directory before the release since we're calling composer update (without --no-dev flag) in the earlier stage?

tmatsuo · 2015-12-04T08:13:46Z

bin/coveralls

If it is called by the phar file, do we still need to require autoload file? If the phar file includes all the deps, there is no need to require them, right?

Is there a way to detect if it's called from within a phar file? If so, can we skip this section in that case?

I'll double check this tonight/tomorrow and report back.

I'm also fine with having a separate files for calling from phar, and calliing from git clone, or composer installation.

Line 5 is required by the phar. Let me know what you want to do as far as keeping this file as is or just using it for the phar.

@onema
Thanks much for checking!

Instead of this You can just use Phar::mapPhar.

keradus · 2015-12-04T11:48:22Z

Please, do not create a phar file if one job passed (eg 5.6) and other failed (eg 5.5).

tmatsuo · 2015-12-04T15:48:11Z

@keradus Great point and agreed. I'm wondering if there's a clean way of doing that just with .travis.yml. Do you know?

keradus · 2015-12-04T15:52:09Z

No. Travis is no-good of deploying libraries and tools, as they are supposed to work on multiple envs. Travis is only good for deploying applications, as they are run under one, unified environment (so 1 job in Travis build using Travis in classic way).

At least that is how it works few months ago, if it changes and you could run deploy not as job section, but as after-whole-build part, that would be sth I would like to see!

onema · 2015-12-04T17:19:47Z

@keradus, @tmatsuo: The build using travis would only run when a tag is created using the selected version of PHP.This would only happen after all the test have been run for all version and have been merged into a common branch (master).

In any case, that is just a proposal and is not present in this PR. The phar can still be created using any method you like by doing this:

curl -LSs http://box-project.github.io/box2/installer.php | php
mkdir -p build/artifacts
php composer.phar install --no-dev --no-interaction
php box.phar build

It can latter be attached to the tag release or distribute in any way you like :)

tmatsuo · 2015-12-04T17:34:20Z

Ah, @onema thanks!

So I can run the release script only for push build to master, also only with a one single env.

I think we should build the phar with --prefer-stable --prefer-lowest in order to make it runnable for older PHP. Is it reasonable to create the phar with the PHP 5.3.3 env with --prefer-stable --prefer-lowest? Is the phar file generated by PHP 5.3.3 also runnable with PHP 7.0?

If you don't have an answer for now, nevermind, I'll test that anyways.

keradus · 2015-12-04T17:37:40Z

I know @onema, but it isn't protect from tag created on code that works on PHP5.6 and didnt work on PHP5.3.
It's true, that that tag shouldn't be created, but you never know.

@tmatsuo, build it on 5.3.3 with highest deps to ensure it works everywhere.
It would also work if builded on any version with lowest deps, but it is great to have it as high as possible, so highest deps for lowest PHP ver.

tmatsuo · 2015-12-04T18:14:20Z

it isn't protect from tag created on code that works on PHP5.6 and didnt work on PHP5.3.

@keradus, From now on, we will never merge red builds into master, so it should be fine.

build it on 5.3.3 with highest deps to ensure it works everywhere.

Thanks! As always :)

This reverts commit 2c66d8e.

tmatsuo · 2015-12-04T21:18:44Z

Just a note, this will fix #92

keradus · 2015-12-05T00:43:00Z

From now on, we will never merge red builds into master, so it should be fine.

It could happen even by accident. Just having multiple jobs on Travis and deploy by Travis isn't the best option.
I do not say it is bad or wont work, it just has some edge cases in which it will build not working code. Sth to have in mind...

tmatsuo · 2015-12-05T20:37:39Z

LGTM

I'm going to merge this. For a time being, I will manually creat the phar. I will revisit automation later.

Thanks again!

Create a .phar file

keradus · 2015-12-06T09:14:25Z

box.json

using compactors would be cool

Please file an issue

nope, just to prove that merging is too fast ;)

Well, everything doesn't need to be perfect :) I'll file it then.

onema added 5 commits December 3, 2015 20:11

Moved coveralls bin directory out of composer.

a2d66e7

Removed bin from ignored files.

2c66d8e

Update coveralls path

03e4f46

Update composer bin path to new coveralls location.

7b1c779

Adding box configuration file.

7b4fb8d

tmatsuo reviewed Dec 4, 2015
View reviewed changes

This was referenced Dec 4, 2015

Phar support? #33

Closed

src directory is not found #92

Closed

tmatsuo reviewed Dec 4, 2015
View reviewed changes

Revert "Removed bin from ignored files."

ce3dc80

This reverts commit 2c66d8e.

tmatsuo mentioned this pull request Dec 4, 2015

Remove srcDir from the Configuration. #127

Merged

tmatsuo pushed a commit that referenced this pull request Dec 5, 2015

Merge pull request #124 from onema/phar-box

ced76e8

Create a .phar file

tmatsuo merged commit ced76e8 into php-coveralls:master Dec 5, 2015

tmatsuo mentioned this pull request Dec 5, 2015

Can not execute from a git clone #134

Closed

keradus reviewed Dec 6, 2015
View reviewed changes

tmatsuo mentioned this pull request Dec 6, 2015

Fixed the wrong path for calling from local git repo #135

Merged

Conversation

onema commented Dec 4, 2015

Objective:

Summary of changes:

Building and deployment:

Uh oh!

tmatsuo commented Dec 4, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tmatsuo commented Dec 4, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

keradus commented Dec 4, 2015

Uh oh!

tmatsuo commented Dec 4, 2015

Uh oh!

keradus commented Dec 4, 2015

Uh oh!

onema commented Dec 4, 2015

Uh oh!

tmatsuo commented Dec 4, 2015

Uh oh!

keradus commented Dec 4, 2015

Uh oh!

tmatsuo commented Dec 4, 2015

Uh oh!

tmatsuo commented Dec 4, 2015

Uh oh!

keradus commented Dec 5, 2015

Uh oh!

tmatsuo commented Dec 5, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants