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.

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

Add tensorflow/io R Package CRAN release instructions #53

Merged
merged 1 commit into from
Jan 17, 2019
Merged
Changes from all commits
Commits
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
28 changes: 28 additions & 0 deletions sigs/io/RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
At the moment SIG IO Releases consist of two parts:
- Release of source code with versioning in GitHub
- Release of python package in PyPI
- Release of R package to CRAN

## GitHub Source Code Release

Expand Down Expand Up @@ -30,6 +31,33 @@ Then upload `artifacts/*.whl` files with:
twine upload artifacts/*
```

## CRAN R Package Release

Before submitting the R package to CRAN, manually perform and check the following items:
* Make sure the documentation in `README.md` and `vignettes` is up-to-date
* Update `Version` field in `DESCRIPTION` file
* Update `NEWS.md` to include items for this new release
* Run `devtools::check()` and fix all the notable issues, especially warnings and errors
* Update `cran-comments.md` to include any unsolvable issues from `devtools::check()` and
other comments/responses to CRAN maintainers
* Run checks on R-hub via `devtools::check_rhub()` and on win-builder via `devtools::check_win_devel()`. This is
optional since Python is not be installed on CRAN test machines and we skip the tests on
CRAN.

To submit the package to CRAN for review, do the following:
* Run `devtools::release()` to submit for review. Here's how it looks like if submission is successful:
```
Submitting file: /var/folders/zp/k98_wphd0h9c5b3zyk5xhnhm0000gn/T//RtmpHh9Wdo/tfio_0.1.0.tar.gz
File size: 483.4 Kb
Uploading package & comments
Confirming submission
Package submission successful.
Check your email for confirmation link.
```
* Check email for confirmation link and confirm the submission
* CRAN maintainers will review the submission and email you for the result of this submission.
If there are any additional issues and comments that need to be addressed, address them and re-submit

## SIG IO Release Team

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