Skip to content

Commit 645581c

Browse files
committed
Fix URL redirects and remove some travis documentation
As travis is no longer the recommended CI for open source R projects
1 parent c5a1a7c commit 645581c

File tree

7 files changed

+10
-54
lines changed

7 files changed

+10
-54
lines changed

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Authors@R: c(
3333
person(family = "Twitter, Inc", role = "cph", comment = "Bootstrap library")
3434
)
3535
Description: Track and report code coverage for your package and (optionally)
36-
upload the results to a coverage service like 'Codecov' <https://codecov.io> or
36+
upload the results to a coverage service like 'Codecov' <https://about.codecov.io> or
3737
'Coveralls' <https://coveralls.io>. Code coverage is a measure of the amount of
3838
code being exercised by a set of tests. It is an indirect measure of test
3939
quality and completeness. This package is compatible with any testing

R/codecov.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
#' @param pr explicitly set the pr this coverage result object corresponds to,
2121
#' this is looked up from the service if it is `NULL`.
2222
#' @param flags A flag to use for this coverage upload see
23-
#' <https://docs.codecov.io/docs/flags> for details.
23+
#' <https://docs.codecov.com/docs/flags> for details.
2424
#' @export
2525
#' @examples
2626
#' \dontrun{

R/covr.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#' covr: Test coverage for packages
22
#'
33
#' covr tracks and reports code coverage for your package and (optionally)
4-
#' upload the results to a coverage service like 'Codecov' <https://codecov.io> or
4+
#' upload the results to a coverage service like 'Codecov' <https://about.codecov.io> or
55
#' 'Coveralls' <https://coveralls.io>. Code coverage is a measure of the amount of
66
#' code being exercised by a set of tests. It is an indirect measure of test
77
#' quality and completeness. This package is compatible with any testing

README.md

Lines changed: 4 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
<!-- badges: start -->
44
[![R-CMD-check](https://github.com/r-lib/covr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-lib/covr/actions/workflows/R-CMD-check.yaml)
5-
[![Codecov test coverage](https://codecov.io/gh/r-lib/covr/branch/master/graph/badge.svg)](https://codecov.io/gh/r-lib/covr?branch=master)
5+
[![Codecov test coverage](https://about.codecov.io/gh/r-lib/covr/branch/master/graph/badge.svg)](https://app.codecov.io/gh/r-lib/covr?branch=master)
66
[![CRAN version](http://www.r-pkg.org/badges/version/covr)](https://cran.r-project.org/package=covr)
77
<!-- badges: end -->
88

99
Track test coverage for your R package and view reports locally or (optionally)
10-
upload the results to [codecov](https://codecov.io/) or [coveralls](https://coveralls.io/).
10+
upload the results to [codecov](https://about.codecov.io/) or [coveralls](https://coveralls.io/).
1111

1212
# Installation #
1313

@@ -18,11 +18,11 @@ install.packages("covr")
1818
devtools::install_github("r-lib/covr")
1919
```
2020

21-
The easiest way to setup covr on [Travis-CI](https://travis-ci.org)
21+
The easiest way to setup covr on [Github Actions](https://github.com/r-lib/actions/tree/v2-branch/examples#test-coverage-workflow)
2222
is with [usethis](https://github.com/r-lib/usethis).
2323

2424
```r
25-
usethis::use_coverage()
25+
usethis::use_github_action("test-coverage")
2626
```
2727

2828
# Usage #
@@ -61,50 +61,6 @@ as.data.frame(cov)
6161
zero_coverage(cov)
6262
```
6363

64-
# Automated reports
65-
66-
## Codecov ##
67-
If you are already using [Travis-CI](https://travis-ci.org) add the
68-
following to your project's `.travis.yml` to track your coverage results
69-
over time with [Codecov](https://codecov.io).
70-
71-
```yml
72-
after_success:
73-
- Rscript -e 'covr::codecov()'
74-
```
75-
76-
If you are using [Appveyor CI](http://ci.appveyor.com) then you can add the
77-
lines below to your project's `appveyor.yml`:
78-
79-
```yml
80-
on_success:
81-
- Rscript -e "covr::codecov()"
82-
```
83-
84-
You also need to install covr, either by adding it to the `Suggests:` field of
85-
your package's `DESCRIPTION` file or also to `Remotes: r-lib/covr` if you want
86-
to install the development version.
87-
88-
To use other CI services or if you want to upload a coverage report locally you
89-
can set environment variable `CODECOV_TOKEN` to the token generated on
90-
the settings page of <https://codecov.io>.
91-
92-
## Coveralls ##
93-
94-
Alternatively you can upload your results to [Coveralls](https://coveralls.io/)
95-
using `covr::coveralls()`.
96-
97-
```yml
98-
after_success:
99-
- Rscript -e 'covr::coveralls()'
100-
```
101-
102-
For CI systems not supported by coveralls you need to set the `COVERALLS_TOKEN`
103-
environment variable. It is wise to use a [Secure Variable](http://docs.travis-ci.com/user/environment-variables/#Secure-Variables)
104-
so that it is not revealed publicly.
105-
106-
Also you will need to turn on coveralls for your project at <https://coveralls.io/repos>.
107-
10864
# Exclusions #
10965

11066
`covr` supports a few of different ways of excluding some or all of a file.

man/codecov.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/covr-package.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

vignettes/how_it_works.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ coverage.
227227

228228
# Codecov.io and Coveralls.io #
229229

230-
[Codecov](https://codecov.io/) and [Coveralls](https://coveralls.io/) are a web services to help you track your code coverage
230+
[Codecov](https://about.codecov.io/) and [Coveralls](https://coveralls.io/) are a web services to help you track your code coverage
231231
over time, and ensure that all new code is appropriately covered.
232232

233233
They both have JSON-based APIs to submit and report on coverage. The functions `codecov` and `coveralls` create outputs that can be consumed by these services.

0 commit comments

Comments
 (0)