Skip to content

Commit e7331cd

Browse files
dieghernandieghernan
committed
Start preparing release
1 parent ff48b8a commit e7331cd

17 files changed

+480
-316
lines changed

‎.github/workflows/rhub.yaml

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
# R-hub's generic GitHub Actions workflow file. It's canonical location is at
2+
# https://github.com/r-hub/actions/blob/v1/workflows/rhub.yaml
3+
# You can update this file to a newer version using the rhub2 package:
4+
#
5+
# rhub::rhub_setup()
6+
#
7+
# It is unlikely that you need to modify this file manually.
8+
9+
name: R-hub
10+
run-name: "${{ github.event.inputs.id }}: ${{ github.event.inputs.name || format('Manually run by {0}', github.triggering_actor) }}"
11+
12+
on:
13+
workflow_dispatch:
14+
inputs:
15+
config:
16+
description: 'A comma separated list of R-hub platforms to use.'
17+
type: string
18+
default: 'linux,windows,macos'
19+
name:
20+
description: 'Run name. You can leave this empty now.'
21+
type: string
22+
id:
23+
description: 'Unique ID. You can leave this empty now.'
24+
type: string
25+
26+
jobs:
27+
28+
setup:
29+
runs-on: ubuntu-latest
30+
outputs:
31+
containers: ${{ steps.rhub-setup.outputs.containers }}
32+
platforms: ${{ steps.rhub-setup.outputs.platforms }}
33+
34+
steps:
35+
# NO NEED TO CHECKOUT HERE
36+
- uses: r-hub/actions/setup@v1
37+
with:
38+
config: ${{ github.event.inputs.config }}
39+
id: rhub-setup
40+
41+
linux-containers:
42+
needs: setup
43+
if: ${{ needs.setup.outputs.containers != '[]' }}
44+
runs-on: ubuntu-latest
45+
name: ${{ matrix.config.label }}
46+
strategy:
47+
fail-fast: false
48+
matrix:
49+
config: ${{ fromJson(needs.setup.outputs.containers) }}
50+
container:
51+
image: ${{ matrix.config.container }}
52+
53+
steps:
54+
- uses: r-hub/actions/checkout@v1
55+
- uses: r-hub/actions/platform-info@v1
56+
with:
57+
token: ${{ secrets.RHUB_TOKEN }}
58+
job-config: ${{ matrix.config.job-config }}
59+
- uses: r-hub/actions/setup-deps@v1
60+
with:
61+
token: ${{ secrets.RHUB_TOKEN }}
62+
job-config: ${{ matrix.config.job-config }}
63+
- uses: r-hub/actions/run-check@v1
64+
with:
65+
token: ${{ secrets.RHUB_TOKEN }}
66+
job-config: ${{ matrix.config.job-config }}
67+
68+
other-platforms:
69+
needs: setup
70+
if: ${{ needs.setup.outputs.platforms != '[]' }}
71+
runs-on: ${{ matrix.config.os }}
72+
name: ${{ matrix.config.label }}
73+
strategy:
74+
fail-fast: false
75+
matrix:
76+
config: ${{ fromJson(needs.setup.outputs.platforms) }}
77+
78+
steps:
79+
- uses: r-hub/actions/checkout@v1
80+
- uses: r-hub/actions/setup-r@v1
81+
with:
82+
job-config: ${{ matrix.config.job-config }}
83+
token: ${{ secrets.RHUB_TOKEN }}
84+
- uses: r-hub/actions/platform-info@v1
85+
with:
86+
token: ${{ secrets.RHUB_TOKEN }}
87+
job-config: ${{ matrix.config.job-config }}
88+
- uses: r-hub/actions/setup-deps@v1
89+
with:
90+
job-config: ${{ matrix.config.job-config }}
91+
token: ${{ secrets.RHUB_TOKEN }}
92+
- uses: r-hub/actions/run-check@v1
93+
with:
94+
job-config: ${{ matrix.config.job-config }}
95+
token: ${{ secrets.RHUB_TOKEN }}

‎CITATION.cff

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ message: 'To cite package "cffr" in publications use:'
88
type: software
99
license: GPL-3.0-or-later
1010
title: 'cffr: Generate Citation File Format (''cff'') Metadata for R Packages'
11-
version: 1.0.1.9000
11+
version: 1.1.0
1212
doi: 10.21105/joss.03900
1313
identifiers:
1414
- type: doi
@@ -143,6 +143,9 @@ references:
143143
email: [email protected]
144144
orcid: https://orcid.org/0000-0002-4035-0289
145145
year: '2024'
146+
identifiers:
147+
- type: url
148+
value: https://arxiv.org/abs/1403.2805
146149
doi: 10.32614/CRAN.package.jsonlite
147150
version: '>= 1.7.2'
148151
- type: software

‎DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: cffr
22
Title: Generate Citation File Format ('cff') Metadata for R Packages
3-
Version: 1.0.1.9000
3+
Version: 1.1.0
44
Authors@R: c(
55
person("Diego", "Hernangómez", , "[email protected]", role = c("aut", "cre", "cph"),
66
comment = c(ORCID = "0000-0001-8457-4658")),

‎NEWS.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# cffr (development version)
1+
# cffr 1.1.0
22

33
- Now **cffr** adds automatically dois to packages on **CRAN** (e.g.
44
<https://doi.org/10.32614/CRAN.package.cffr>):
@@ -10,6 +10,7 @@
1010
the package dependency is on **CRAN**, the **CRAN** doi would be used
1111
for the dependency in the `references` key.
1212
- Extract `commit` from `RemoteSha`.
13+
- Update `cran_to_spdx` dataset.
1314

1415
# cffr 1.0.1
1516

‎R/cff.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,10 @@ cff <- function(path, ...) {
6464
if (!missing(path)) {
6565
src <- detect_x_source(path)
6666
if (src == "cff_citation") {
67-
lifecycle::deprecate_soft("1.0.0", "cff(path)", "cff_read_cff_citation()")
67+
lifecycle::deprecate_warn("1.0.0", "cff(path)", "cff_read_cff_citation()")
6868
return(cff_read_cff_citation(path))
6969
} else {
70-
lifecycle::deprecate_soft("1.0.0", "cff(path)",
70+
lifecycle::deprecate_warn("1.0.0", "cff(path)",
7171
details = "Argument ignored."
7272
)
7373
}

‎R/deprecated.R

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
cff_extract_to_bibtex <- function(x,
2424
what = c("preferred", "references", "all")) {
2525
if (requireNamespace("lifecycle", quietly = TRUE)) {
26-
lifecycle::deprecate_soft(
26+
lifecycle::deprecate_warn(
2727
"0.5.0", "cff_extract_to_bibtex()",
2828
details = "Function renamed, use `as_bibentry()` instead."
2929
)
@@ -37,7 +37,7 @@ cff_extract_to_bibtex <- function(x,
3737
cff_to_bibtex <- function(x,
3838
what = c("preferred", "references", "all")) {
3939
if (requireNamespace("lifecycle", quietly = TRUE)) {
40-
lifecycle::deprecate_soft(
40+
lifecycle::deprecate_warn(
4141
"1.0.0", "cff_extract_to_bibtex()",
4242
details = "Function renamed, use `as_bibentry()` instead."
4343
)
@@ -103,7 +103,7 @@ cff_to_bibtex <- function(x,
103103
cff_from_bibtex <- function(x, encoding = "UTF-8", ...) {
104104
if (length(x) == 1 && file_exist_abort(x)) {
105105
if (requireNamespace("lifecycle", quietly = TRUE)) {
106-
lifecycle::deprecate_soft(
106+
lifecycle::deprecate_warn(
107107
"1.0.0", "cff_from_bibtex()", "cff_read_bib()"
108108
)
109109
}
@@ -113,7 +113,7 @@ cff_from_bibtex <- function(x, encoding = "UTF-8", ...) {
113113
}
114114

115115
if (requireNamespace("lifecycle", quietly = TRUE)) {
116-
lifecycle::deprecate_soft(
116+
lifecycle::deprecate_warn(
117117
"1.0.0", "cff_from_bibtex()", "cff_read_bib_text()"
118118
)
119119
}
@@ -162,7 +162,7 @@ write_bib <- function(x,
162162
verbose = TRUE,
163163
ascii = FALSE) {
164164
if (requireNamespace("lifecycle", quietly = TRUE)) {
165-
lifecycle::deprecate_soft(
165+
lifecycle::deprecate_warn(
166166
"1.0.0", "write_bib()", "cff_write_bib()"
167167
)
168168
}
@@ -178,7 +178,7 @@ write_citation <- function(x,
178178
verbose = TRUE,
179179
...) {
180180
if (requireNamespace("lifecycle", quietly = TRUE)) {
181-
lifecycle::deprecate_soft(
181+
lifecycle::deprecate_warn(
182182
"1.0.0", "write_citation()", "cff_write_citation()"
183183
)
184184
}
@@ -245,7 +245,7 @@ write_citation <- function(x,
245245
#' as_cff_person("Herbert von Karajan")
246246
cff_parse_person <- function(person) {
247247
if (requireNamespace("lifecycle", quietly = TRUE)) {
248-
lifecycle::deprecate_soft(
248+
lifecycle::deprecate_warn(
249249
"1.0.0", "cff_parse_person()", "as_cff_person()"
250250
)
251251
}
@@ -257,7 +257,7 @@ cff_parse_person <- function(person) {
257257
#'
258258
cff_parse_person_bibtex <- function(person) {
259259
if (requireNamespace("lifecycle", quietly = TRUE)) {
260-
lifecycle::deprecate_soft(
260+
lifecycle::deprecate_warn(
261261
"1.0.0", "cff_parse_person_bibtex()", "as_cff_person()"
262262
)
263263
}
@@ -292,7 +292,7 @@ cff_parse_person_bibtex <- function(person) {
292292
#'
293293
cff_parse_citation <- function(bib) {
294294
if (requireNamespace("lifecycle", quietly = TRUE)) {
295-
lifecycle::deprecate_soft(
295+
lifecycle::deprecate_warn(
296296
"1.0.0", "cff_parse_citation()", "as_cff.bibentry()"
297297
)
298298
}

‎README.Rmd

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ knitr::opts_chunk$set(
2323
[![CRAN-results](https://badges.cranchecks.info/worst/cffr.svg)](https://cran.r-project.org/web/checks/check_results_cffr.html)
2424
[![Downloads](https://cranlogs.r-pkg.org/badges/grand-total/cffr?color=blue)](https://cran.r-project.org/package=cffr)
2525
[![R-CMD-check](https://github.com/ropensci/cffr/actions/workflows/check-full.yaml/badge.svg)](https://github.com/ropensci/cffr/actions/workflows/check-full.yaml)
26+
[![R-hub](https://github.com/ropensci/cffr/actions/workflows/rhub.yaml/badge.svg)](https://github.com/ropensci/cffr/actions/workflows/rhub.yaml)
2627
[![codecov](https://codecov.io/gh/ropensci/cffr/branch/main/graph/badge.svg?token=YRO3XL8RWK)](https://app.codecov.io/gh/ropensci/cffr)
2728
[![r-universe](https://ropensci.r-universe.dev/badges/cffr)](https://ropensci.r-universe.dev/cffr)
2829
[![CITATION-cff](https://github.com/ropensci/cffr/actions/workflows/cff-validator.yml/badge.svg)](https://github.com/ropensci/cffr/actions/workflows/cff-validator.yml)

‎README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
[![CRAN-results](https://badges.cranchecks.info/worst/cffr.svg)](https://cran.r-project.org/web/checks/check_results_cffr.html)
1010
[![Downloads](https://cranlogs.r-pkg.org/badges/grand-total/cffr?color=blue)](https://cran.r-project.org/package=cffr)
1111
[![R-CMD-check](https://github.com/ropensci/cffr/actions/workflows/check-full.yaml/badge.svg)](https://github.com/ropensci/cffr/actions/workflows/check-full.yaml)
12+
[![R-hub](https://github.com/ropensci/cffr/actions/workflows/rhub.yaml/badge.svg)](https://github.com/ropensci/cffr/actions/workflows/rhub.yaml)
1213
[![codecov](https://codecov.io/gh/ropensci/cffr/branch/main/graph/badge.svg?token=YRO3XL8RWK)](https://app.codecov.io/gh/ropensci/cffr)
1314
[![r-universe](https://ropensci.r-universe.dev/badges/cffr)](https://ropensci.r-universe.dev/cffr)
1415
[![CITATION-cff](https://github.com/ropensci/cffr/actions/workflows/cff-validator.yml/badge.svg)](https://github.com/ropensci/cffr/actions/workflows/cff-validator.yml)
@@ -72,7 +73,7 @@ file and the `CITATION` file (if present) of your package. Note that
7273
**cffr** works best if your package pass
7374
`R CMD check/devtools::check()`.
7475

75-
As per 2024-07-19 there are at least 288 repos on GitHub using **cffr**.
76+
As per 2024-07-23 there are at least 290 repos on GitHub using **cffr**.
7677
[Check them out
7778
here](https://github.com/search?q=cffr%20path%3A**%2FCITATION.cff&type=code).
7879

@@ -393,6 +394,9 @@ test <- cff_create("rmarkdown")
393394
email: [email protected]
394395
orcid: https://orcid.org/0000-0002-4035-0289
395396
year: '2024'
397+
identifiers:
398+
- type: url
399+
value: https://arxiv.org/abs/1403.2805
396400
doi: 10.32614/CRAN.package.jsonlite
397401
- type: software
398402
title: knitr
@@ -933,8 +937,7 @@ for more info.
933937

934938
## References
935939

936-
<div id="refs" class="references csl-bib-body hanging-indent"
937-
entry-spacing="0">
940+
<div id="refs" class="references csl-bib-body hanging-indent">
938941

939942
<div id="ref-codemeta" class="csl-entry">
940943

‎codemeta.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@
88
"codeRepository": "https://github.com/ropensci/cffr",
99
"issueTracker": "https://github.com/ropensci/cffr/issues",
1010
"license": "https://spdx.org/licenses/GPL-3.0",
11-
"version": "1.0.1.9000",
11+
"version": "1.1.0",
1212
"programmingLanguage": {
1313
"@type": "ComputerLanguage",
1414
"name": "R",
1515
"url": "https://r-project.org"
1616
},
17-
"runtimePlatform": "R version 4.4.1 (2024-06-14 ucrt)",
17+
"runtimePlatform": "R version 4.4.1 (2024-06-14)",
1818
"provider": {
1919
"@id": "https://cran.r-project.org",
2020
"@type": "Organization",
@@ -200,7 +200,7 @@
200200
},
201201
"isPartOf": "https://ropensci.org",
202202
"keywords": ["attribution", "citation", "credit", "citation-files", "cff", "metadata", "r", "r-package", "citation-file-format", "rstats", "ropensci", "cran"],
203-
"fileSize": "1629.12KB",
203+
"fileSize": "1604.564KB",
204204
"citation": [
205205
{
206206
"@type": "ScholarlyArticle",

0 commit comments

Comments
 (0)