From ac381175a75de0160eff67f0f141057d3ce473c2 Mon Sep 17 00:00:00 2001 From: Steve Boyd Date: Thu, 23 Jun 2022 09:55:39 +1200 Subject: [PATCH] DOC Update readme with phpcoverage_force_off input (#19) --- .github/workflows/ci.yml | 3 ++- README.md | 6 +++++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 2fe7403..bd07963 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -60,7 +60,8 @@ jobs: # github.ref_name - The branch or tag name that triggered the workflow run - same as github.ref though without the leading refs/[heads|tags]/ echo "github.ref_name: $GITHUB_REF_NAME" # gitbub.repository - The owner and repository name. For example, Codertocat/Hello-World - echo "$github.repository: $GITHUB_REPOSITORY" + # On forked repos, this will show / + echo "github.repository: $GITHUB_REPOSITORY" # Generates a dynamic matrix of jobs to run tests on based on the inputs provided genmatrix: diff --git a/README.md b/README.md index dead2b5..2db6973 100644 --- a/README.md +++ b/README.md @@ -59,9 +59,13 @@ Runs phpcs and phpstan if the `phpcs.xml.dist` or `phpstan.neon.dist` config fil `phplinting: false` ##### PHP coverage -Run codecov, which does not require a configuration file. Default is false, though modules on the silverstripe account will always have this enabled. Enable with: +Run codecov, which does not require a configuration file. Default is false, though for CI runs on the silverstripe account this option will be ignored and codecov is set to run in [gha-generate-matrix](https://github.com/silvestripe/gha-matrix). Enable with: `phpcoverage: true` +##### PHP coverage force off +Force codecov off for CI runs on the silverstripe account. Default is false. Enable with: +`phpcoverage_force_off: true` + ##### End-to-end tests Runs behat tests if `behat.yml` is available. Default is true, disable with: `endtoend: false`