Skip to content

Commit

Permalink
DOC Update readme with phpcoverage_force_off input (#19)
Browse files Browse the repository at this point in the history
  • Loading branch information
emteknetnz authored Jun 22, 2022
1 parent dda5367 commit ac38117
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 <account_of_fork>/<repo>
echo "github.repository: $GITHUB_REPOSITORY"
# Generates a dynamic matrix of jobs to run tests on based on the inputs provided
genmatrix:
Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down

0 comments on commit ac38117

Please sign in to comment.