Add support for Github Actions #275

Smolevich · 2019-10-21T20:20:11Z

Add support Github actions for collector
Add test case

renekorss · 2019-10-22T05:04:13Z

src/Bundle/CoverallsBundle/Collector/CiEnvVarsCollector.php

@@ -64,6 +64,7 @@ public function collect(array $env)
            ->fillAppVeyor()
            ->fillJenkins()
            ->fillLocal()
+            ->fillGithubActiions()


Typo: double i

Smolevich · 2019-10-22T08:54:41Z

Travis build for PHP with version 7.1 failed

> php dev-tools/vendor/bin/phpmd src text build/config/phpmd.xml

/home/travis/build/php-coveralls/php-coveralls/src/Bundle/CoverallsBundle/Command/CoverallsJobsCommand.php:24
The class CoverallsJobsCommand has a coupling between objects value of 13. Consider to reduce the number of dependencies under 13.

Script php dev-tools/vendor/bin/phpmd src text build/config/phpmd.xml handling the sca event returned with error code 2

I don't know that it means

Smolevich · 2019-10-22T08:55:28Z

Do we need Github Actions ci file for this PR?

Smolevich · 2019-10-22T08:58:25Z

@keradus, can you review please?

ADmad · 2019-11-12T07:30:33Z

Could the maintainers review / merge this please.

Smolevich · 2019-11-12T08:34:11Z

As I understand this repo has one member - @keradus and judging by the status on the github he is on vacation

Smolevich · 2019-11-12T08:35:27Z

@ADmad you can use this repo for sending events to coveralls.io

ADmad · 2019-11-12T08:36:35Z

Thanks @Smolevich.

See php-coveralls/php-coveralls#275

…ons (see #963) Description ----------- Unfortunately, we have to delay using GitHub actions to generate the coverage reports until php-coveralls/php-coveralls#275 has been addressed. Commits ------- 88c0c24 Remove the coverage workflow until php-coveralls supports GitHub actions

leofeyer · 2019-11-13T07:10:59Z

Unfortunately, this does not work for pull requests, because GITHUB_REF is set to refs/remotes/pull/123/merge instead of refs/heads/… (see this log). Then Coveralls will not associate the build with the pull request (see this build) and never report the status back to GitHub.

keradus · 2019-11-20T14:08:20Z

hey. exactly, i was on hols. thanks for understanding.

I took care of Travis build for PHP with version 7.1 failed issue on 2.1 branch, please merge/rebase the PR to see it.

@Smolevich, can you please look at @leofeyer concern? thanks!

Smolevich · 2019-11-20T20:08:04Z

hey. exactly, i was on hols. thanks for understanding.

I took care of Travis build for PHP with version 7.1 failed issue on 2.1 branch, please merge/rebase the PR to see it.

@Smolevich, can you please look at @leofeyer concern? thanks!

Ok, i see case @leofeyer. @keradus, What branch should merge in branch for PR?

…ub-actions

Smolevich · 2019-11-20T20:21:46Z

@leofeyer, see build

Smolevich · 2020-01-22T17:07:39Z

@keradus can you review please?

emmetog · 2020-02-06T17:06:01Z

I've tried to test this PR again (instructions here) but it's not working, I believe it's because coveralls doesn't yet handle the "github" service_name.

When I modify this PR branch to hardcode CI_JOB_ID and CI_NAME to null it generates a coveralls.json as follows:

    "service_name": "",
    "service_branch": "my-branch",
    "repo_token": "<<redacted>>",
    "git": {
    ...

this seems to work ☝️

However the PR in its current state creates a coveralls.json like this:

    "service_name": "github",
    "service_job_id": "44727b6d6df5c15b11b26579f72d9b8edd8069a1",
    "service_branch": "my-branch",
    "repo_token": "<<redacted>>",
    "git": {
    ...

which does not work 😞 It fails with the following output:

...
Collect git info
Read environment variables
Dump submitting json file: /path/coveralls.json
File size: 968.15 kB
Submitting to https://coveralls.io/api/v1/jobs
Client error occurred. status: 422 Unprocessable Entity
Couldn't find a repository matching this job.
elapsed time: 2.054 sec memory: 10.00 MB

The official coveralls docs suggest that the service_name and service_job_id are optional, it seems that if these are present and valid then coveralls asks the relevant CI system for additional info to supplement it's analysis.

I suspect it's failing because coveralls doesn't yet recognise the "github" service_name or it's not working yet or something.

Should we set the service name and job ID to be null or not present for the moment until Coveralls handles them correctly?

simPod · 2020-02-06T17:16:19Z

This works well for me simPod@b9c9d4c I reversed engineered their js implementation and api so I'm setting the same fields as they do.

I don't have BRANCH set. Try it without it.

Smolevich · 2020-02-06T17:36:22Z

@emmetog can i show your test?

Smolevich · 2020-02-06T17:41:13Z

@emmetog you can see on work PR here https://github.com/jenssegers/laravel-mongodb/pull/1920/checks

emmetog · 2020-02-07T11:48:40Z

@Smolevich For my test I first set the env vars:

$ export CI_NAME='github'
$ export GITHUB_ACTIONS=1
$ export GITHUB_REF=refs/heads/my-branch
$ export GITHUB_SHA=44727b6d6df5c15b11b26579f72d9b8edd8069a1
$ export COVERALLS_REPO_TOKEN=<<redacted>>
$ export GITHUB_EVENT_NAME=pull_request

Then I run phpunit to generate the clover coverage xml and run coveralls to push them:

$ ./vendor/bin/phpunit --coverage-clover coverage/clover.xml
$ vendor/bin/php-coveralls --coverage_clover coverage/clover.xml --json_path coveralls.json -vvv

I'm using a private GitHub repo. The php-coveralls package in my vendor/ is using this exact PR which can be set up by following the instructions here.

@simPod I tried removing the branch as you suggested but still no joy 😞 Here's the coveralls.json that was generated:

    "service_name": "github",
    "service_job_id": "44727b6d6df5c15b11b26579f72d9b8edd8069a1",
    "repo_token": "<<redacted>>",
    "git": {

Could you add a step in your github-actions file to show the generated /home/runner/work/laravel-mongodb/laravel-mongodb/build/logs/coveralls-upload.json file in that repository that works? Something like this:

      - name: Debug converalls.json
        run: cat /home/runner/work/laravel-mongodb/laravel-mongodb/build/logs/coveralls-upload.json

Smolevich · 2020-02-07T11:50:37Z

@Smolevich For my test I first set the env vars:
$ export CI_NAME='github'
$ export GITHUB_ACTIONS=1
$ export GITHUB_REF=refs/heads/my-branch
$ export GITHUB_SHA=44727b6d6df5c15b11b26579f72d9b8edd8069a1
$ export COVERALLS_REPO_TOKEN=<<redacted>>
$ export GITHUB_EVENT_NAME=pull_request
Then I run phpunit to generate the clover coverage xml and run coveralls to push them:
$ ./vendor/bin/phpunit --coverage-clover coverage/clover.xml
$ vendor/bin/php-coveralls --coverage_clover coverage/clover.xml --json_path coveralls.json -vvv
I'm using a private GitHub repo. The php-coveralls package in my vendor/ is using this exact PR which can be set up by following the instructions here.

@simPod I tried removing the branch as you suggested but still no joy 😞 Here's the coveralls.json that was generated:
    "service_name": "github",
    "service_job_id": "44727b6d6df5c15b11b26579f72d9b8edd8069a1",
    "repo_token": "<<redacted>>",
    "git": {
Could you add a step in your github-actions file to show the generated /home/runner/work/laravel-mongodb/laravel-mongodb/build/logs/coveralls-upload.json file in that repository that works? Something like this:
      - name: Debug converalls.json
        run: cat /home/runner/work/laravel-mongodb/laravel-mongodb/build/logs/coveralls-upload.json

What is the version php-coveralls in composer.json?

emmetog · 2020-02-07T12:06:14Z

Interestingly, setting COVERALLS_RUN_LOCALLY in my github-actions job seems to make everything work (my composer is still locked to this PR branch). in other words:

      - name: Upload coverage results to Coveralls
        run: vendor/bin/php-coveralls --coverage_clover coverage/clover.xml --json_path coveralls.json -vvv
        env:
            COVERALLS_RUN_LOCALLY: 1

From what I've seen this also sets the branch and pull request link details correctly in the coveralls UI. This suggests that the changes which are made when COVERALLS_RUN_LOCALLY=1 are the correct ones for github actions (they work):

        if (isset($this->env['COVERALLS_RUN_LOCALLY']) && $this->env['COVERALLS_RUN_LOCALLY']) {
            $this->env['CI_JOB_ID'] = null;
            $this->env['CI_NAME'] = 'php-coveralls';
            $this->env['COVERALLS_EVENT_TYPE'] = 'manual';
            // ....

Smolevich · 2020-02-07T12:46:22Z

Interestingly, setting COVERALLS_RUN_LOCALLY in my github-actions job seems to make everything work (my composer is still locked to this PR branch). in other words:
      - name: Upload coverage results to Coveralls
        run: vendor/bin/php-coveralls --coverage_clover coverage/clover.xml --json_path coveralls.json -vvv
        env:
            COVERALLS_RUN_LOCALLY: 1
From what I've seen this also sets the branch and pull request link details correctly in the coveralls UI. This suggests that the changes which are made when COVERALLS_RUN_LOCALLY=1 are the correct ones for github actions (they work):
        if (isset($this->env['COVERALLS_RUN_LOCALLY']) && $this->env['COVERALLS_RUN_LOCALLY']) {
            $this->env['CI_JOB_ID'] = null;
            $this->env['CI_NAME'] = 'php-coveralls';
            $this->env['COVERALLS_EVENT_TYPE'] = 'manual';
            // ....

See https://github.com/Smolevich/reindexer-client/runs/431760052?check_suite_focus=true
PR Smolevich/reindexer-client#12

emmetog · 2020-02-07T12:55:37Z

src/Bundle/CoverallsBundle/Collector/GitInfoCollector.php

@@ -74,9 +74,9 @@ protected function collectBranch()

        foreach ($branchesResult as $result) {
            if (strpos($result, '* ') === 0) {
-                $exploded = explode('* ', $result, 2);
+                preg_match('~^\* (?:\(HEAD detached at )?([\w/]+)\)?~', $result, $matches);


This breaks for branches which have hyphens (-) and other non-word characters in them. This method incorrectly extracts my for the branch name when the full branch name is my-branch for example.

@Smolevich I'll fix this and send you PR, k?

My branch has hyphen and this code don't break

(edit: fixed the code of the test)

Here's a test which replicates the problem (feel free to use it in this PR):

/** * @test */ public function shouldParseCaseInsensitive() { $branches = [ ' TEST-123', '* TEST-456', ' TEST-789', ]; $gitCommand = $this->createGitCommandStubWith($branches, $this->getHeadCommitValue, $this->getRemotesValue); $object = new GitInfoCollector($gitCommand); $result =$object->collect(); $this->assertEquals('TEST-456', $result->getBranch()); }

I've seen that github actions checks out the code in detached HEAD (HEAD detached at...) but when running locally it's not detached and it returns TEST instead of TEST-456.

this also broke prod release :(
https://travis-ci.org/github/php-coveralls/php-coveralls/jobs/733117026#L565

I also recovered support for hyphens
#298

twinh · 2020-06-14T10:10:46Z

Hello, I have merged the PR into my forked repo, added parallel job support, and published a new release, feel free to use it.

https://github.com/twinh/php-coveralls#github-actions

Add a new step after phpunit generate coverage report.

- name: Upload coverage results to Coveralls
  env:
    COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  run: |
    composer global require twinh/php-coveralls
    php-coveralls --coverage_clover=build/logs/clover.xml -v

OndraM · 2020-09-04T09:35:23Z

src/Bundle/CoverallsBundle/Collector/CiEnvVarsCollector.php

+            $jobId = $githubRef;
+        }
+
+        $this->env['CI_JOB_ID'] = $jobId;


Suggested change

$this->env['CI_JOB_ID'] = $jobId;

$this->env['CI_JOB_ID'] = $this->env['GITHUB_RUN_NUMBER'];

$this->env['GITHUB_RUN_NUMBER'] is now available should be used instead of the custom commit hash based value.

https://docs.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables

@OndraM maybe, but seems like maintainers ignore this PR and communication with community is broken

szepeviktor · 2020-09-28T03:05:43Z

@OndraM @keradus Could we somehow support GHA?
It is 1 year old.
https://github.blog/2019-08-08-github-actions-now-supports-ci-cd/

Maybe with #296?

simPod · 2020-09-28T15:51:19Z

Anyone considering / already migrated to codecov and can share experience?

szepeviktor · 2020-09-28T15:57:33Z

migrated to codecov

Coveralls is the superior service.
I use and advocate https://github.com/twinh/php-coveralls

SignpostMarv · 2020-09-29T09:42:30Z

Anyone considering / already migrated to codecov and can share experience?

they've got a github action for it, works fine.

ADmad · 2020-09-29T10:56:51Z

Anyone considering / already migrated to codecov and can share experience?

They use the GH annotations API so that you get comments on the lines without code coverage on the pull request page itself.

keradus · 2020-10-05T21:13:42Z

I merged the extended version of this PR - the #296.

big thanks to work on that!
i kept your co-ownership when merging to master ;)

Add support for Github Actions

367798f

Smolevich mentioned this pull request Oct 21, 2019

Add support for Github actions #273

Closed

renekorss reviewed Oct 22, 2019

View reviewed changes

Smolevich added 4 commits October 22, 2019 08:12

Change typo

452ce4e

Add return for Github Actions

e605806

Fix failed test

f2fbd9e

Fix cs errors

ac9dbc1

leofeyer added a commit to contao/contao that referenced this pull request Nov 12, 2019

Use a forked php-coveralls package until GitHub actions are supported

a764417

See php-coveralls/php-coveralls#275

leofeyer mentioned this pull request Nov 12, 2019

Remove the coverage workflow until php-coveralls supports GitHub actions contao/contao#963

Merged

leofeyer added a commit to contao/contao that referenced this pull request Nov 12, 2019

Use a forked php-coveralls package until GitHub actions are supported

94d50d8

See php-coveralls/php-coveralls#275

leofeyer added a commit to contao/contao that referenced this pull request Nov 12, 2019

Use a forked php-coveralls package until GitHub actions are supported

65929a5

See php-coveralls/php-coveralls#275

leofeyer added a commit to contao/contao that referenced this pull request Nov 12, 2019

Use a forked php-coveralls package until GitHub actions are supported

20e8fc2

See php-coveralls/php-coveralls#275

leofeyer added a commit to contao/contao that referenced this pull request Nov 12, 2019

Use a forked php-coveralls package until GitHub actions are supported

a1e4324

See php-coveralls/php-coveralls#275

leofeyer added a commit to contao/contao that referenced this pull request Nov 12, 2019

Use a forked php-coveralls package until GitHub actions are supported

c61abbe

See php-coveralls/php-coveralls#275

keradus changed the base branch from 2.1 to 2.2 November 20, 2019 15:41

keradus force-pushed the 2.2 branch from aac1422 to 3e6420f Compare November 20, 2019 16:33

Smolevich added 2 commits November 20, 2019 23:14

Merge remote-tracking branch 'upstream/2.2' into add-support-for-gith…

bb38e5d

…ub-actions

Merge 2.2 and add blank yaml for GIthub Actions

16fed6b

Smolevich force-pushed the add-support-for-github-actions branch from cb09f1c to 42b8068 Compare January 16, 2020 22:39

Fix failed tests

895f08e

Smolevich mentioned this pull request Jan 21, 2020

Add matrix for mongodb mongodb/laravel-mongodb#1920

Merged

Smolevich mentioned this pull request Jan 22, 2020

[refactor] Replaced Coveralls with Codecov mongodb/laravel-mongodb#1922

Merged

emmetog reviewed Feb 7, 2020

View reviewed changes

OndraM mentioned this pull request Feb 18, 2020

Setup code-coverage reports OndraM/ci-detector#53

Merged

moufmouf mentioned this pull request Feb 24, 2020

Hard-coding coveralls secret thecodingmachine/safe#198

Closed

sj-i mentioned this pull request Jul 27, 2020

Add links to badges in README sj-i/typist#3

Merged

OndraM reviewed Sep 4, 2020

View reviewed changes

keradus changed the base branch from 2.2 to 2.3 September 24, 2020 23:15

keradus force-pushed the 2.3 branch from ddbf9ad to 1bd927e Compare September 24, 2020 23:21

twinh mentioned this pull request Sep 28, 2020

Add Github Actions and COVERALLS_FLAG_NAME support #296

Merged

keradus closed this Oct 5, 2020

azjezz mentioned this pull request Oct 7, 2020

use TravisCI to send code coverage azjezz/psl#79

Merged

	$this->env['CI_JOB_ID'] = $jobId;
	$this->env['CI_JOB_ID'] = $this->env['GITHUB_RUN_NUMBER'];

Add support for Github Actions #275

Add support for Github Actions #275

Conversation

Smolevich commented Oct 21, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Smolevich commented Oct 22, 2019

Smolevich commented Oct 22, 2019

Smolevich commented Oct 22, 2019

ADmad commented Nov 12, 2019

Smolevich commented Nov 12, 2019

Smolevich commented Nov 12, 2019

ADmad commented Nov 12, 2019

leofeyer commented Nov 13, 2019 • edited

keradus commented Nov 20, 2019

Smolevich commented Nov 20, 2019

Smolevich commented Nov 20, 2019

Smolevich commented Jan 22, 2020

emmetog commented Feb 6, 2020

simPod commented Feb 6, 2020 • edited

Smolevich commented Feb 6, 2020

Smolevich commented Feb 6, 2020

emmetog commented Feb 7, 2020

Smolevich commented Feb 7, 2020

emmetog commented Feb 7, 2020

Smolevich commented Feb 7, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

emmetog Feb 7, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

twinh commented Jun 14, 2020

OndraM Sep 4, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

szepeviktor commented Sep 28, 2020 • edited

simPod commented Sep 28, 2020

szepeviktor commented Sep 28, 2020 • edited

SignpostMarv commented Sep 29, 2020

ADmad commented Sep 29, 2020

keradus commented Oct 5, 2020

leofeyer commented Nov 13, 2019 •

edited

simPod commented Feb 6, 2020 •

edited

Smolevich commented Feb 7, 2020 •

edited

emmetog Feb 7, 2020 •

edited

OndraM Sep 4, 2020 •

edited

szepeviktor commented Sep 28, 2020 •

edited

szepeviktor commented Sep 28, 2020 •

edited