Merge pull request #205 from EasyPost/makefile

chore: introduces Makefile for consistent command usage

Author: Justintime50

.github/workflows/ci.yml

@@ -17,9 +17,9 @@ jobs:
       - name: install composer
         run: composer self-update
       - name: install dependencies
-        run: composer install --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
+        run: make install
       - name: lint
-        run: composer lint
+        run: make lint
   run-tests:
     runs-on: ubuntu-20.04
     strategy:
@@ -43,8 +43,8 @@ jobs:
       - name: install composer
         run: composer self-update
       - name: install dependencies
-        run: composer install --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
+        run: make install
       - name: test with phpunit on ${{ matrix.phpversion }}
-        run: EASYPOST_TEST_API_KEY=123 EASYPOST_PROD_API_KEY=123 composer test
+        run: EASYPOST_TEST_API_KEY=123 EASYPOST_PROD_API_KEY=123 make test
       - name: Security scan
-        run: composer scan
+        run: make scan

Makefile

@@ -0,0 +1,42 @@
+## help - Display help about make targets for this Makefile
+help:
+	@cat Makefile | grep '^## ' --color=never | cut -c4- | sed -e "`printf 's/ - /\t- /;'`" | column -s "`printf '\t'`" -t
+
+## clean - Cleans the project
+clean:
+	rm -rf vendor clover.xml clover.html bin .phpunit.cache
+
+## coverage - Runs the test suite and generates a coverage report
+coverage:
+	composer coverage
+
+## fix - Fix linting errors
+fix:
+	composer fix
+
+## install - Install dependencies
+install:
+	composer install --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
+
+## lint - Lint the project
+lint:
+	composer lint
+
+## release - Cuts a release for the project on GitHub (requires GitHub CLI)
+# tag = The associated tag title of the release
+release:
+	gh release create ${tag}
+
+## scan - Runs security analysis on the project
+scan:
+	composer scan
+
+## test - Test the project
+test:
+	composer test
+
+## update - Update dependencies
+update:
+	composer update
+
+.PHONY: help clean fix install lint release scan test update

README.md

@@ -74,19 +74,25 @@ Upgrading major versions of this project? Refer to the [Upgrade Guide](UPGRADE_G
 
 ```bash
 # Install dependencies
-composer install
+make install
+
+# Update dependencies
+make update
 
 # Lint project
-composer lint
+make lint
 
 # Fix linting errors
-composer fix
+make fix
 
 # Run tests
-EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... composer test
+EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... make test
 
 # Generate coverage reports (requires Xdebug for HTML report)
-EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... composer coverage
+EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... make coverage
+
+# Run security analysis
+make scan
 ```
 
 ### Testing

composer.json

@@ -24,7 +24,7 @@
   },
   "require-dev": {
     "allejo/php-vcr-sanitizer": "^1.0.9",
-    "php-vcr/php-vcr": "^1.5",
+    "php-vcr/php-vcr": "1.5.2",
     "phpunit/phpunit": "^9",
     "squizlabs/php_codesniffer": "^3.6",
     "roave/security-advisories": "dev-latest"