replace the travis ci with github actions, and replace the vagrantfile with a dockerfile

triplepoint · triplepoint · commit a887389ccb7a · 2025-04-30T12:06:11.000-07:00
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,8 @@
+.github
+.dockerignore
+.gitattributes
+.gitignore
+.git
+CHANGELOG.md
+Dockerfile
+README.md
diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml
@@ -0,0 +1,39 @@
+name: PHP Composer
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Validate composer.json and composer.lock
+      run: composer validate --strict
+
+    - name: Cache Composer packages
+      id: composer-cache
+      uses: actions/cache@v3
+      with:
+        path: vendor
+        key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-php-
+
+    - name: Install dependencies
+      run: composer install --prefer-dist --no-progress
+
+    - name: Run test suite
+      run: composer run-script lint
+
+    - name: Run test suite
+      run: composer run-script test
diff --git a/.travis.yml b/.travis.yml
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,3 @@
+FROM php:7.4-cli
+RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin && ln -s /usr/local/bin/composer.phar /usr/local/bin/composer
+WORKDIR /project
diff --git a/README.md b/README.md
@@ -286,37 +286,14 @@ The workflow for this repository goes as follows:
 End users of this repository should only use tagged commits in production.  Users interested in the current 'soon-to-be-released' code may use `master`, with the understanding that it may change unexpectedly.  All other existing branches (if any) should be considered 'feature' branches in development, and not yet ready for use.
 
 ### Local Testing Environment
-There's a Vagrant virtual machine configuration included which is suitable for running the necessary unit tests.  To bring up the machine, make sure you have Vagrant and Virtualbox installed, and from the project root directory:
+There's a `Dockerfile` and a set of helper scripts in `scripts/` suitable for running the necessary unit tests.  With Docker installed, do:
 
+``` shell
+# Execute the lint checks
+./script/lint
 
-``` bash
-vagrant up
-vagrant ssh
-cd /project
+# Execute the unit tests
+./script/test
 ```
 
-### Setting Up for Testing
-The virtual machine development environment already has Composer installed.  Once you're ssh'ed into the virtual machine, install this project's dev dependencies:
-
-``` bash
-rm -rf vendor
-composer.phar update --verbose --prefer-dist
-```
-
-### Unit Tests
-All the tests associated with this project can be manually run with:
-
-``` bash
-vendor/bin/phpunit -c ./tests/phpunit.xml.dist ./tests
-```
-
-### CodeSniffer
-Codesniffer verifies that coding standards are being met.  Once the project is built with development dependencies, you can run the checks with:
-
-``` bash
-vendor/bin/phpcs --encoding=utf-8 --extensions=php --standard=./tests/phpcs.xml -nsp ./
-```
-
-### Continuous Integration
-The above tests are automatically run against Github commits with Travis-CI.
-- https://travis-ci.org/PhpUnitsOfMeasure/php-units-of-measure
+In addition, `./script/shell` will get you a bash shell in a temporary container.  Note that the hosts directory is mounted into the container, and changes to files inside the container will persist.
diff --git a/Vagrantfile b/Vagrantfile
diff --git a/composer.json b/composer.json
@@ -1,52 +1,45 @@
 {
-    "name":        "php-units-of-measure/php-units-of-measure",
-
+    "name": "php-units-of-measure/php-units-of-measure",
     "description": "A PHP library for converting between standard units of measure.",
-
     "keywords": [
-         "measurements", "data", "conversion"
-     ],
-
-    "homepage":    "https://github.com/PhpUnitsOfMeasure/php-units-of-measure",
-
+        "measurements",
+        "data",
+        "conversion"
+    ],
+    "homepage": "https://github.com/PhpUnitsOfMeasure/php-units-of-measure",
     "license": "MIT",
-
     "authors": [
         {
-            "name":     "Jonathan Hanson",
-            "email":    "jonathan@jonathan-hanson.org",
-            "homepage": "http://www.jonathan-hanson.org/",
-            "role":     "Developer"
+            "name": "Jonathan Hanson",
+            "role": "Developer"
         }
     ],
-
     "support": {
-        "email":  "jonathan@jonathan-hanson.org",
         "issues": "https://github.com/PhpUnitsOfMeasure/php-units-of-measure/issues",
         "source": "https://github.com/PhpUnitsOfMeasure/php-units-of-measure"
     },
-
     "require": {
         "php": ">=5.5.0"
     },
-
     "require-dev": {
-        "phpunit/phpunit":           "4.8.*",
+        "phpunit/phpunit": "4.8.*",
         "squizlabs/php_codesniffer": "2.8.1"
     },
-
     "replace": {
         "triplepoint/php-units-of-measure": "*"
     },
-    
     "autoload": {
         "psr-4": {
             "PhpUnitsOfMeasure\\": "source/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-             "PhpUnitsOfMeasureTest\\": "tests/"
+            "PhpUnitsOfMeasureTest\\": "tests/"
         }
+    },
+    "scripts": {
+        "test": "phpunit -c ./tests/phpunit.xml.dist ./tests",
+        "lint": "phpcs --encoding=utf-8 --extensions=php --standard=./tests/phpcs.xml -nsp ./"
     }
 }
diff --git a/scripts/lint b/scripts/lint
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -e
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )/..
+
+docker build -t "php-units-of-measure:dev" .
+docker run -it --rm -v `pwd`:/project "php-units-of-measure:dev" composer run-script lint
diff --git a/scripts/shell b/scripts/shell
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -e
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )/..
+
+docker build -t "php-units-of-measure:dev" .
+docker run -it --rm -v `pwd`:/project "php-units-of-measure:dev" bash
diff --git a/scripts/test b/scripts/test
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -e
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )/..
+
+docker build -t "php-units-of-measure:dev" .
+docker run -it --rm -v `pwd`:/project "php-units-of-measure:dev" composer run-script test

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+FROM php:7.4-cli`
	`2`	`+RUN curl -sS https://getcomposer.org/installer \| php -- --install-dir=/usr/local/bin && ln -s /usr/local/bin/composer.phar /usr/local/bin/composer`
	`3`	`+WORKDIR /project`