From 3378dc7a99711ba77803208ecb078688f446b78a Mon Sep 17 00:00:00 2001 From: Steve Boyd Date: Mon, 1 Aug 2022 10:07:52 +1200 Subject: [PATCH] MNT Standardise modules --- .github/workflows/ci.yml | 2 +- .github/workflows/keepalive.yml | 2 +- .scrutinizer.yml | 15 --------------- .travis.yml | 4 ---- readme.md => README.md | 14 +++++--------- phpunit.xml.dist | 1 + 6 files changed, 8 insertions(+), 30 deletions(-) delete mode 100644 .scrutinizer.yml delete mode 100644 .travis.yml rename readme.md => README.md (91%) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 5cb4ecf..dfbd85b 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -12,5 +12,5 @@ jobs: ci: name: CI # Only run cron on the silverstripe account - if: (github.event_name == 'schedule' && startsWith(github.repository, 'silverstripe/')) || (github.event_name != 'schedule') + if: (github.event_name == 'schedule' && github.repository_owner == 'silverstripe') || (github.event_name != 'schedule') uses: silverstripe/gha-ci/.github/workflows/ci.yml@v1 diff --git a/.github/workflows/keepalive.yml b/.github/workflows/keepalive.yml index ebf9716..4cf5fbb 100644 --- a/.github/workflows/keepalive.yml +++ b/.github/workflows/keepalive.yml @@ -10,7 +10,7 @@ jobs: keepalive: name: Keepalive # Only run cron on the silverstripe account - if: (github.event_name == 'schedule' && startsWith(github.repository, 'silverstripe/')) || (github.event_name != 'schedule') + if: (github.event_name == 'schedule' && github.repository_owner == 'silverstripe') || (github.event_name != 'schedule') runs-on: ubuntu-latest steps: - name: Keepalive diff --git a/.scrutinizer.yml b/.scrutinizer.yml deleted file mode 100644 index 051ef9a..0000000 --- a/.scrutinizer.yml +++ /dev/null @@ -1,15 +0,0 @@ -inherit: true - -build: - nodes: - analysis: - tests: - override: [php-scrutinizer-run] - -checks: - php: - code_rating: true - duplication: true - -filter: - paths: [src/*, tests/*] diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index c244c3b..0000000 --- a/.travis.yml +++ /dev/null @@ -1,4 +0,0 @@ -version: ~> 1.0 - -import: - - silverstripe/silverstripe-travis-shared:config/provision/standard-jobs-range.yml diff --git a/readme.md b/README.md similarity index 91% rename from readme.md rename to README.md index 46560a9..7e94583 100644 --- a/readme.md +++ b/README.md @@ -1,11 +1,7 @@ -# SilverStripe Environment Checker Module +# Silverstripe Environment Checker Module [![CI](https://github.com/silverstripe/silverstripe-environmentcheck/actions/workflows/ci.yml/badge.svg)](https://github.com/silverstripe/silverstripe-environmentcheck/actions/workflows/ci.yml) -[![SilverStripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/) -[![Code Quality](https://scrutinizer-ci.com/g/silverstripe/silverstripe-environmentcheck/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/silverstripe/silverstripe-environmentcheck/?branch=master) -[![Code Coverage](https://codecov.io/gh/silverstripe/silverstripe-environmentcheck/branch/master/graph/badge.svg)](https://codecov.io/gh/silverstripe/silverstripe-environmentcheck) -[![Version](http://img.shields.io/packagist/v/silverstripe/environmentcheck.svg?style=flat-square)](https://packagist.org/packages/silverstripe/environmentcheck) -[![License](http://img.shields.io/packagist/l/silverstripe/environmentcheck.svg?style=flat-square)](LICENSE.md) +[![Silverstripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/) This module adds an API for running environment checks to your API. @@ -15,10 +11,10 @@ This module adds an API for running environment checks to your API. ## Requirements -* SilverStripe 4.x +* Silverstripe 4.x * PHP 7.3 -For SilverStripe 3.x support, please use a `1.x` tagged release. +For Silverstripe 3.x support, please use a `1.x` tagged release. ## Aren't these just unit tests? @@ -111,7 +107,7 @@ SilverStripe\EnvironmentCheck\EnvironmentChecker: from_email_address: admin@test.com ``` -Errors can be logged via the standard SilverStripe PSR-3 compatible logging. Each check will cause an individual log +Errors can be logged via the standard Silverstripe PSR-3 compatible logging. Each check will cause an individual log entry. You can choose to enable logging separately for warnings and errors, identified through the result of `EnvironmentCheck->check()`. diff --git a/phpunit.xml.dist b/phpunit.xml.dist index 5a7f2af..25925bf 100644 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -1,3 +1,4 @@ +