From ffe829485e57f1f59250e2264ce5d8b034345670 Mon Sep 17 00:00:00 2001 From: Steve Boyd Date: Mon, 1 Aug 2022 10:02:22 +1200 Subject: [PATCH] MNT Standardise modules --- .github/workflows/ci.yml | 2 +- .github/workflows/keepalive.yml | 2 +- .scrutinizer.yml | 69 --------------------------------- README.md | 6 +-- 4 files changed, 5 insertions(+), 74 deletions(-) delete mode 100644 .scrutinizer.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index f5cf08c..d728e00 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 d1ebd80..0000000 --- a/.scrutinizer.yml +++ /dev/null @@ -1,69 +0,0 @@ -inherit: true - -checks: - php: - verify_property_names: true - verify_argument_usable_as_reference: true - verify_access_scope_valid: true - useless_calls: true - use_statement_alias_conflict: true - variable_existence: true - unused_variables: true - unused_properties: true - unused_parameters: true - unused_methods: true - unreachable_code: true - too_many_arguments: true - sql_injection_vulnerabilities: true - simplify_boolean_return: true - side_effects_or_types: true - security_vulnerabilities: true - return_doc_comments: true - return_doc_comment_if_not_inferrable: true - require_scope_for_properties: true - require_scope_for_methods: true - require_php_tag_first: true - psr2_switch_declaration: true - psr2_class_declaration: true - property_assignments: true - prefer_while_loop_over_for_loop: true - precedence_mistakes: true - precedence_in_conditions: true - phpunit_assertions: true - php5_style_constructor: true - parse_doc_comments: true - parameter_non_unique: true - parameter_doc_comments: true - param_doc_comment_if_not_inferrable: true - optional_parameters_at_the_end: true - one_class_per_file: true - no_unnecessary_if: true - no_trailing_whitespace: true - no_property_on_interface: true - no_non_implemented_abstract_methods: true - no_error_suppression: true - no_duplicate_arguments: true - no_commented_out_code: true - newline_at_end_of_file: true - missing_arguments: true - method_calls_on_non_object: true - instanceof_class_exists: true - foreach_traversable: true - fix_line_ending: true - fix_doc_comments: true - duplication: true - deprecated_code_usage: true - deadlock_detection_in_loops: true - code_rating: true - closure_use_not_conflicting: true - catch_class_exists: true - blank_line_after_namespace_declaration: false - avoid_multiple_statements_on_same_line: true - avoid_duplicate_types: true - avoid_conflicting_incrementers: true - avoid_closing_tag: true - assignment_of_null_return: true - argument_type_checks: true - -filter: - paths: [code/*, tests/*] diff --git a/README.md b/README.md index 0534f7e..bbe29c1 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ *It's completely possible to allow any user to become an admin, or do other nefarious things, if this is installed on a live site.* This module starts a testing session in a browser, -in order to test a SilverStripe application in a clean state. +in order to test a Silverstripe application in a clean state. Usually the session is started on a fresh database with only default records loaded. Further data can be loaded from YAML fixtures or database dumps. @@ -26,7 +26,7 @@ E.g. the silverstripe-behat-extension may use it through this module APIs, allowing us to introduce some grey-box testing techniques. The module also serves as an initializer for the -[SilverStripe Behat Extension](https://github.com/silverstripe-labs/silverstripe-behat-extension/). +[Silverstripe Behat Extension](https://github.com/silverstripe-labs/silverstripe-behat-extension/). It is required for Behat because the Behat CLI test runner needs to persist test configuration just for the tested browser connection, available on arbitary URL endpoints. For example, @@ -35,7 +35,7 @@ into a temporary database table for inspection by the CLI-based process. ## Setup -Simply require the module in a SilverStripe webroot (3.0 or newer): +Simply require the module in a Silverstripe webroot (3.0 or newer): composer require --dev silverstripe/behat-extension