{"action":"created","issue":{"url":"https://api.github.com/repos/googlegenomics/api-client-r/issues/35","labels_url":"https://api.github.com/repos/googlegenomics/api-client-r/issues/35/labels{/name}","comments_url":"https://api.github.com/repos/googlegenomics/api-client-r/issues/35/comments","events_url":"https://api.github.com/repos/googlegenomics/api-client-r/issues/35/events","html_url":"https://github.com/googlegenomics/api-client-r/issues/35","id":64334882,"number":35,"title":"Document steps for new package releases","user":{"login":"deflaux","id":1395500,"avatar_url":"https://avatars.githubusercontent.com/u/1395500?v=3","gravatar_id":"","url":"https://api.github.com/users/deflaux","html_url":"https://github.com/deflaux","followers_url":"https://api.github.com/users/deflaux/followers","following_url":"https://api.github.com/users/deflaux/following{/other_user}","gists_url":"https://api.github.com/users/deflaux/gists{/gist_id}","starred_url":"https://api.github.com/users/deflaux/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/deflaux/subscriptions","organizations_url":"https://api.github.com/users/deflaux/orgs","repos_url":"https://api.github.com/users/deflaux/repos","events_url":"https://api.github.com/users/deflaux/events{/privacy}","received_events_url":"https://api.github.com/users/deflaux/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":{"login":"siddharthab","id":1929612,"avatar_url":"https://avatars.githubusercontent.com/u/1929612?v=3","gravatar_id":"","url":"https://api.github.com/users/siddharthab","html_url":"https://github.com/siddharthab","followers_url":"https://api.github.com/users/siddharthab/followers","following_url":"https://api.github.com/users/siddharthab/following{/other_user}","gists_url":"https://api.github.com/users/siddharthab/gists{/gist_id}","starred_url":"https://api.github.com/users/siddharthab/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/siddharthab/subscriptions","organizations_url":"https://api.github.com/users/siddharthab/orgs","repos_url":"https://api.github.com/users/siddharthab/repos","events_url":"https://api.github.com/users/siddharthab/events{/privacy}","received_events_url":"https://api.github.com/users/siddharthab/received_events","type":"User","site_admin":false},"milestone":null,"comments":3,"created_at":"2015-03-25T18:01:01Z","updated_at":"2015-03-25T18:37:26Z","closed_at":null,"body":"After #28 is complete, let's be sure to document the exact steps for a new release much like we have for \r\n[utils-java](https://github.com/googlegenomics/utils-java#making-a-new-release)\r\n\r\nFor example, click on the RStudio \"check\" button which takes care of running the following:\r\n```\r\nroxygen2::roxygenize('.', roclets=c('rd'))\r\nR CMD build api-client-r\r\nR CMD check --as-cran GoogleGenomics_0.1.2.tar.gz\r\n```\r\n\r\nand then for BioConductor to pick up the release do . . ."},"comment":{"url":"https://api.github.com/repos/googlegenomics/api-client-r/issues/comments/86163139","html_url":"https://github.com/googlegenomics/api-client-r/issues/35#issuecomment-86163139","issue_url":"https://api.github.com/repos/googlegenomics/api-client-r/issues/35","id":86163139,"user":{"login":"siddharthab","id":1929612,"avatar_url":"https://avatars.githubusercontent.com/u/1929612?v=3","gravatar_id":"","url":"https://api.github.com/users/siddharthab","html_url":"https://github.com/siddharthab","followers_url":"https://api.github.com/users/siddharthab/followers","following_url":"https://api.github.com/users/siddharthab/following{/other_user}","gists_url":"https://api.github.com/users/siddharthab/gists{/gist_id}","starred_url":"https://api.github.com/users/siddharthab/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/siddharthab/subscriptions","organizations_url":"https://api.github.com/users/siddharthab/orgs","repos_url":"https://api.github.com/users/siddharthab/repos","events_url":"https://api.github.com/users/siddharthab/events{/privacy}","received_events_url":"https://api.github.com/users/siddharthab/received_events","type":"User","site_admin":false},"created_at":"2015-03-25T18:37:26Z","updated_at":"2015-03-25T18:37:26Z","body":"This is the first time I am hearing a [bike-shedding](http://en.wikipedia.org/wiki/Parkinson%27s_law_of_triviality) reference in a review process. :+1: \r\nI agree with you Tim on the points you made.\r\n\r\nThe entire process can be fairly automated including the roxygen stuff. And now that I used jimhester's lintr tool, I am going to move to using that for this package. In fact, the lintr run will be part of unit tests, and so Travis will make it difficult to submit your patch without lintr compliance.\r\n\r\nDocumentation that is not close to source code does indeed tend to get outdated and perish. Also why we use roxygen instead of separately written man pages. So this will be a fairly small section in the [CONTRIBUTING](https://github.com/googlegenomics/api-client-r/blob/master/CONTRIBUTING.rst) file. Basically, I will add just one more command there to the existing commands, one that will update man pages based on source code doc by running roxygen.\r\n\r\nI will most likely set up a [bridge](http://www.bioconductor.org/developers/how-to/git-svn/) between github and bioc so pickup by bioconductor will be automatic. I will add a note about version number increment to actually publish an updated package to the devel repository."}}