From d4ad63391eabd795341fd4dee66b8faa05a10e2a Mon Sep 17 00:00:00 2001 From: Casey McLaughlin Date: Mon, 21 Dec 2020 10:49:13 -0500 Subject: [PATCH] change README.md badges and add new `coverage.svg` badge --- CHANGELOG.md | 5 +++++ README.md | 11 ++++++----- composer.json | 5 +++-- coverage.svg | 21 +++++++++++++++++++++ 4 files changed, 35 insertions(+), 7 deletions(-) create mode 100644 coverage.svg diff --git a/CHANGELOG.md b/CHANGELOG.md index 2cbb228..53e0376 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added - Parameter in `reset` method to optionally preserve the resumptionToken +- GitHub Actions build status badge in `README.md` +- Automatic SVG badge generation for code coverage + +### Removed +- `.travis.yml` build support (switched to Github Actions) ## [v3.2] - 2020-09-13 ### Changed diff --git a/README.md b/README.md index 8b9f1ec..67784c4 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,12 @@ PHPOAIPMH ## A PHP OAI-PMH harvester client library -[![Latest Version](https://img.shields.io/github/release/caseyamcl/phpoaipmh.svg?style=flat-square?style=flat-square)](https://github.com/caseyamcl/phpoaipmh/releases) -[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md) -[![Build Status](https://travis-ci.org/caseyamcl/Phpoiapmh.png)](https://travis-ci.org/caseyamcl/Phpoiapmh.png) -[![Total Downloads](https://img.shields.io/packagist/dt/caseyamcl/Phpoaipmh.svg?style=flat-square)](https://packagist.org/packages/caseyamcl/Phpoaipmh) -[![Scrutinizer](https://img.shields.io/scrutinizer/g/caseyamcl/phpoaipmh.svg?style=flat-square)](https://scrutinizer-ci.com/g/caseyamcl/phpoaipmh/) +[![Latest Version](https://img.shields.io/github/release/caseyamcl/phpoaipmh.svg)](https://github.com/caseyamcl/phpoaipmh/releases) +[![Total Downloads](https://img.shields.io/packagist/dt/caseyamcl/Phpoaipmh.svg)](https://packagist.org/packages/caseyamcl/Phpoaipmh) +[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE.md) +[![Github Build](https://github.com/caseyamcl/phpoaipmh/workflows/Github%20Build/badge.svg)](https://github.com/caseyamcl/phpoaipmh/actions?query=workflow%3A%22Github+Build%22) +[![Code coverage](https://github.com/caseyamcl/toc/blob/master/coverage.svg)](coverage.svg) +[![Scrutinizer](https://img.shields.io/scrutinizer/g/caseyamcl/phpoaipmh.svg)](https://scrutinizer-ci.com/g/caseyamcl/phpoaipmh/) This library provides an interface to harvest OAI-PMH metadata from any [OAI 2.0 compliant endpoint](http://www.openarchives.org/OAI/openarchivesprotocol.html#ListMetadataFormats). diff --git a/composer.json b/composer.json index b1ca82c..e933e8d 100644 --- a/composer.json +++ b/composer.json @@ -25,7 +25,8 @@ "symfony/console": "^3.4|^4.3|^5.0", "symfony/dependency-injection": "^3.4.26|^4.3|^5.0", "symfony/config": "^3.4|^4.3|^5.0", - "symfony/yaml": "^3.4|^4.3|^5.0" + "symfony/yaml": "^3.4|^4.3|^5.0", + "jaschilz/php-coverage-badger": "^2.0" }, "autoload": { "psr-4": { @@ -34,7 +35,7 @@ } }, "scripts": { - "test": "phpunit", + "test": "phpunit; vendor/bin/php-coverage-badger build/logs/clover.xml ./coverage.svg", "quicktest": "phpunit --no-coverage", "check-style": "phpcs -p --standard=PSR12 --runtime-set ignore_errors_on_exit 1 --runtime-set ignore_warnings_on_exit 1 src tests", "fix-style": "phpcbf -p --standard=PSR12 --runtime-set ignore_errors_on_exit 1 --runtime-set ignore_warnings_on_exit 1 src tests" diff --git a/coverage.svg b/coverage.svg new file mode 100644 index 0000000..3f8f605 --- /dev/null +++ b/coverage.svg @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + coverage + coverage + 92% + 92% + + \ No newline at end of file