Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC Update readme with phpcoverage_force_off input #19

Merged
merged 1 commit into from
Jun 22, 2022
Merged

DOC Update readme with phpcoverage_force_off input #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
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>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this mean for PRs as well? If not, what situations will this be run from a forked repo?

Copy link
Member Author

@emteknetnz emteknetnz Jun 22, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not actually sure, once we've merged the framework ci.yml we can do a PR to it and see what comes up in context. I'm going to assume it'll be silverstripe, if not and it shows the fork, meaning the action is running on the fork and not the base, it's not the end of the world, it just means that codecov won't run on the pull-request, though it will run post merge on the 4 / 4.11 branch. We don't block PR's based on codecov declining, it's more of an ongoing metric

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
View file
Open in desktop
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