Skip to content

Commit

Permalink
update code cov action
Browse files Browse the repository at this point in the history
  • Loading branch information
cjrace committed Feb 10, 2024
1 parent a3fd796 commit 7998d36
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 20 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@
^pkgdown$
^\.github$
^CODE_OF_CONDUCT\.md$
^codecov\.yml$
10 changes: 2 additions & 8 deletions .github/workflows/test-coverage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [main]
branches: [main, master]
pull_request:
branches: [main]
branches: [main, master]

name: test-coverage

Expand Down Expand Up @@ -48,9 +48,3 @@ jobs:
with:
name: coverage-test-failures
path: ${{ runner.temp }}/package

- name: Upload coverage reports to Codecov
uses: codecov/codecov-action@v4.0.1
env:
token: ${{ secrets.CODECOV_TOKEN }}
slug: dfe-analytical-services/dfeR
19 changes: 7 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,19 @@
# dfeR

---

<!-- badges: start -->
[![R-CMD-check](https://github.com/dfe-analytical-services/dfeR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/dfe-analytical-services/dfeR/actions/workflows/R-CMD-check.yaml)
[![pkgdown](https://github.com/dfe-analytical-services/dfeR/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/dfe-analytical-services/dfeR/actions/workflows/pkgdown.yaml)
[![test-coverage](https://github.com/dfe-analytical-services/dfeR/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/dfe-analytical-services/dfeR/actions/workflows/test-coverage.yaml)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![Codecov test coverage](https://codecov.io/gh/dfe-analytical-services/dfeR/branch/main/graph/badge.svg)](https://app.codecov.io/gh/dfe-analytical-services/dfeR?branch=main)
<!-- badges: end -->

---
# dfeR

## Introduction

dfeR is an R package designed to help standardise R programming across the Department for Education (DfE) and facilitate sharing of business specific functions.
`dfeR` is an R package designed to help standardise R programming across the Department for Education (DfE) and facilitate sharing of business specific functions.

**Scope**

dfeR is open to all of DfE and anything we think could be useful to other programmers and analysts can be contributed.
`dfeR` is open to all of DfE and anything we think could be useful to other programmers and analysts can be contributed.

Functionality is expected to focus around the following:

Expand All @@ -32,7 +28,7 @@ Documentation for what has been included in the package so far is available at h

## Installation

dfeR is not currently available on CRAN. For the time being you can install the development version from GitHub.
`dfeR` is not currently available on CRAN. For the time being you can install the development version from GitHub.

If you are using `renv` in your project (recommended):

Expand All @@ -50,13 +46,13 @@ devtools::install_github("dfe-analytical-services/dfeR")

## Proxy

The need for setting proxy settings in order to be able to work with R and git within the DfE estate has now ended. If you previously run the proxy script in previous versions of the DfE R package, then contact the [Statistics Development team](statistics.development@education.gov.uk) to assist in cleaning out your system settings.
The need for setting proxy settings in order to be able to work with R and Git within the DfE estate has now ended. If you previously run the proxy script in previous versions of the `dfeR` package, then contact the [Statistics Development team](statistics.development@education.gov.uk) to assist in cleaning out your system settings.

---

## Contributing

Ideas for dfeR should first be raised as a [GitHub issue](https://github.com/dfe-analytical-services/dfeR) after which anyone is free to write the code and create a pull request for review.
Ideas for `dfeR` should first be raised as a [GitHub issue](https://github.com/dfe-analytical-services/dfeR) after which anyone is free to write the code and create a pull request for review.

When contributing to dfeR you should work on a new branch and, where applicable, you will be asked to:

Expand All @@ -73,4 +69,3 @@ Once your changes have been merged they should appear almost immediately, though
## Code of Conduct

Please note that the dfeR project is released with a [Contributor Code of Conduct](https://dfe-analytical-services.github.io/dfeR/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.

14 changes: 14 additions & 0 deletions codecov.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
comment: false

coverage:
status:
project:
default:
target: auto
threshold: 1%
informational: true
patch:
default:
target: auto
threshold: 1%
informational: true

0 comments on commit 7998d36

Please sign in to comment.