Add justfile, remove coveralls, and fix AUTOLOAD in CI (#1801)

* add justfile and tweak CI + readme * debug test * Debugging * further debugging * restore original composer json * add more logging * maybe fix ci * Fix typo * fix test naming and pass autoload directly to recipe as arugment * Remove unused logline and fix typo * restore composer * remove extra log line * update justfile * add comments * update ci * revert to gh action
stripe · Jan 9, 2025 · e2b61e0 · e2b61e0
1 parent d89ed48
commit e2b61e0
Show file tree

Hide file tree

Showing 7 changed files with 87 additions and 37 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -37,18 +37,14 @@ jobs:
 
     runs-on: ubuntu-latest
 
-    strategy:
-      matrix:
-        php-version:
-          - "8.2"
-
     steps:
+      - uses: extractions/setup-just@v2
       - uses: actions/checkout@v3
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: ${{ matrix.php-version }}
+          php-version: "8.2"
 
       - name: Get Composer Cache Directory
         id: composer-cache
@@ -69,19 +65,17 @@ jobs:
         run: composer install --prefer-dist --no-progress
 
       - name: Run phpstan
-        run: make phpstan
+        run: just lint
 
   tests:
-    name: Tests
-
     runs-on: ubuntu-latest
 
     strategy:
       fail-fast: false
       matrix:
-        env:
-          - AUTOLOAD=0
-          - AUTOLOAD=1
+        autoload:
+          - "0"
+          - "1"
         php-version:
           - "5.6"
           - "7.0"
@@ -92,15 +86,16 @@ jobs:
           - "8.0"
           - "8.1"
           - "8.2"
+    name: Tests (php@${{ matrix.php-version }}, AUTOLOAD=${{ matrix.autoload }})
 
     steps:
+      - uses: extractions/setup-just@v2
       - uses: actions/checkout@v3
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-version }}
-          coverage: xdebug
 
       - name: Get Composer Cache Directory
         id: composer-cache
@@ -125,17 +120,10 @@ jobs:
       - uses: stripe/openapi/actions/stripe-mock@master
 
       - name: Run test suite
+        # --yes skips the confirmation dialogue for the CI test, which modifies files
         run: |
           php --version
-          make ci-test
-
-      - name: Coveralls
-        if: matrix.php-version == '8.2' && matrix.env == 'AUTOLOAD=1'
-        uses: coverallsapp/github-action@v2
-        with:
-          files: clover.xml
-          flag-name: php-${{ matrix.php-version }}-${{ matrix.env }}
-          github-token: ${{ secrets.GITHUB_TOKEN }}
+          just --yes ci-test ${{ matrix.autoload }}
 
   publish:
     # Doesn't actually publish. The publish happens via a packagist webhook configured in the Github UI. But we still display a message here

diff --git a/.gitignore b/.gitignore
@@ -13,9 +13,6 @@ build/*
 # If the vendor directory isn't being commited the composer.lock file should also be ignored
 composer.lock
 
-# Ignore PHPUnit coverage file
-clover.xml
-
 # Ignore IDE's configuration files
 .idea
 

diff --git a/Makefile b/Makefile
@@ -1,3 +1,5 @@
+# NOTE: this file is deprecated and slated for deletion; prefer using the equivalent `just` commands.
+
 export PHPDOCUMENTOR_VERSION := v3.0.0
 
 vendor: composer.json
@@ -12,6 +14,7 @@ test: vendor
 .PHONY: test
 
 ci-test: vendor
+	echo "calling build with $$AUTOLOAD"
 	./build.php $$AUTOLOAD
 .PHONY: ci-test
 

diff --git a/README.md b/README.md
@@ -4,7 +4,6 @@
 [![Latest Stable Version](https://poser.pugx.org/stripe/stripe-php/v/stable.svg)](https://packagist.org/packages/stripe/stripe-php)
 [![Total Downloads](https://poser.pugx.org/stripe/stripe-php/downloads.svg)](https://packagist.org/packages/stripe/stripe-php)
 [![License](https://poser.pugx.org/stripe/stripe-php/license.svg)](https://packagist.org/packages/stripe/stripe-php)
-[![Code Coverage](https://coveralls.io/repos/stripe/stripe-php/badge.svg?branch=master)](https://coveralls.io/r/stripe/stripe-php?branch=master)
 
 The Stripe PHP library provides convenient access to the Stripe API from
 applications written in the PHP language. It includes a pre-defined set of
@@ -249,7 +248,9 @@ New features and bug fixes are released on the latest major version of the Strip
 
 ## Development
 
-Get [Composer][composer]. For example, on Mac OS:
+We use [just](https://github.com/casey/just) for conveniently running development tasks. You can use them directly, or copy the commands out of the `justfile`. To our help docs, run `just`.
+
+To get started, install [Composer][composer]. For example, on Mac OS:
 
 ```bash
 brew install composer
@@ -258,7 +259,8 @@ brew install composer
 Install dependencies:
 
 ```bash
-composer install
+just install
+# or: composer install
 ```
 
 The test suite depends on [stripe-mock], so make sure to fetch and run it from a
@@ -273,13 +275,15 @@ stripe-mock
 Install dependencies as mentioned above (which will resolve [PHPUnit](http://packagist.org/packages/phpunit/phpunit)), then you can run the test suite:
 
 ```bash
-./vendor/bin/phpunit
+just test
+# or: ./vendor/bin/phpunit
 ```
 
 Or to run an individual test file:
 
 ```bash
-./vendor/bin/phpunit tests/Stripe/UtilTest.php
+just test tests/Stripe/UtilTest.php
+# or: ./vendor/bin/phpunit tests/Stripe/UtilTest.php
 ```
 
 Update bundled CA certificates from the [Mozilla cURL release][curl]:
@@ -291,7 +295,8 @@ Update bundled CA certificates from the [Mozilla cURL release][curl]:
 The library uses [PHP CS Fixer][php-cs-fixer] for code formatting. Code must be formatted before PRs are submitted, otherwise CI will fail. Run the formatter with:
 
 ```bash
-./vendor/bin/php-cs-fixer fix -v .
+just format
+# or: ./vendor/bin/php-cs-fixer fix -v .
 ```
 
 ## Attention plugin developers

diff --git a/justfile b/justfile
@@ -0,0 +1,63 @@
+import? '../sdk-codegen/justfile'
+
+set quiet
+
+# make vendored executables callable directly
+export PATH := "vendor/bin:" + env_var('PATH')
+
+_default:
+    just --list --unsorted
+
+# install vendored dependencies; only used locally
+install:
+    composer install
+
+# ⭐ run full unit test suite; needs stripe-mock
+[no-exit-message]
+test *args:
+    phpunit {{ args }}
+
+# run tests in CI; can use autoload mode (or not)
+[confirm("This will modify local files and is intended for use in CI; do you want to proceed?")]
+ci-test autoload:
+    ./build.php {{ autoload }}
+
+# ⭐ format all files
+format *args:
+    PHP_CS_FIXER_IGNORE_ENV=1 php-cs-fixer fix -v --using-cache=no {{ args }}
+
+# for backwards compatibility; ideally removed later
+[private]
+alias codegen-format := format
+
+# check formatting for, but don't modify, files
+format-check: (format "--dry-run")
+
+# ⭐ statically analyze code
+lint *args:
+    php -d memory_limit=512M vendor/bin/phpstan analyse lib tests {{args}}
+
+# for backwards compatibility; ideally removed later
+[private]
+alias phpstan := lint
+
+# called by tooling
+[private]
+update-version version:
+    echo "{{ version }}" > VERSION
+    perl -pi -e 's|VERSION = '\''[.\-\w\d]+'\''|VERSION = '\''{{ version }}'\''|' lib/Stripe.php
+
+
+PHPDOCUMENTOR_VERSION := "v3.0.0"
+# generates docs; currently broken? can unhide if working
+[private]
+phpdoc:
+    #!/usr/bin/env bash
+    set -euo pipefail
+
+    if [ ! -f vendor/bin/phpdoc ]; then
+        curl -sfL https://github.com/phpDocumentor/phpDocumentor/releases/download/{{ PHPDOCUMENTOR_VERSION }}/phpDocumentor.phar -o vendor/bin/phpdoc
+        chmod +x vendor/bin/phpdoc
+    fi
+
+    phpdoc
diff --git a/phpunit.no_autoload.xml b/phpunit.no_autoload.xml
@@ -17,7 +17,4 @@
             <directory>lib</directory>
         </whitelist>
     </filter>
-    <logging>
-        <log type="coverage-clover" target="clover.xml"/>
-    </logging>
 </phpunit>
diff --git a/phpunit.xml b/phpunit.xml
@@ -17,7 +17,4 @@
             <directory>lib</directory>
         </whitelist>
     </filter>
-    <logging>
-        <log type="coverage-clover" target="clover.xml"/>
-    </logging>
 </phpunit>