Skip to content

Commit 0512aeb

Browse files
terrytangyuanewilderj
authored andcommitted
Add tensorflow/io R Package CRAN release instructions (#53)
1 parent 401c1bc commit 0512aeb

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

sigs/io/RELEASE.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
At the moment SIG IO Releases consist of two parts:
44
- Release of source code with versioning in GitHub
55
- Release of python package in PyPI
6+
- Release of R package to CRAN
67

78
## GitHub Source Code Release
89

@@ -30,6 +31,33 @@ Then upload `artifacts/*.whl` files with:
3031
twine upload artifacts/*
3132
```
3233

34+
## CRAN R Package Release
35+
36+
Before submitting the R package to CRAN, manually perform and check the following items:
37+
* Make sure the documentation in `README.md` and `vignettes` is up-to-date
38+
* Update `Version` field in `DESCRIPTION` file
39+
* Update `NEWS.md` to include items for this new release
40+
* Run `devtools::check()` and fix all the notable issues, especially warnings and errors
41+
* Update `cran-comments.md` to include any unsolvable issues from `devtools::check()` and
42+
other comments/responses to CRAN maintainers
43+
* Run checks on R-hub via `devtools::check_rhub()` and on win-builder via `devtools::check_win_devel()`. This is
44+
optional since Python is not be installed on CRAN test machines and we skip the tests on
45+
CRAN.
46+
47+
To submit the package to CRAN for review, do the following:
48+
* Run `devtools::release()` to submit for review. Here's how it looks like if submission is successful:
49+
```
50+
Submitting file: /var/folders/zp/k98_wphd0h9c5b3zyk5xhnhm0000gn/T//RtmpHh9Wdo/tfio_0.1.0.tar.gz
51+
File size: 483.4 Kb
52+
Uploading package & comments
53+
Confirming submission
54+
Package submission successful.
55+
Check your email for confirmation link.
56+
```
57+
* Check email for confirmation link and confirm the submission
58+
* CRAN maintainers will review the submission and email you for the result of this submission.
59+
If there are any additional issues and comments that need to be addressed, address them and re-submit
60+
3361
## SIG IO Release Team
3462

3563
Everybody with an interest in helping SIG IO releases, is welcome

0 commit comments

Comments
 (0)