Merge pull request #214 from bburns632/release/v0.4.0

Release/v0.4.0

CONTRIBUTING.md

@@ -7,8 +7,10 @@ The goal of this guide is to help you contribute to `pkgnet` as quickly and as e
 2. [Submitting a Pull Request](#prs)
 3. [Code Style](#style)
 4. [Running Tests Locally](#testing)
-5. [Releasing to CRAN (for maintainer)](#cran)
+5. [Package Versioning](#version)
+6. [Releasing to CRAN (for maintainer)](#cran)
 
+***
 ## Creating an Issue <a name="issues"></a>
 
 To report bugs, request features, or ask questions about the structure of the code, please [open an issue](https://github.com/UptakeOpenSource/pkgnet/issues).
@@ -39,6 +41,7 @@ Good feature requests will note all of the following:
 
 If you're interested in submitting a pull request to address the bug you're reporting, please indicate that in the issue.
 
+***
 ## Submitting a Pull Request <a name="prs"></a>
 
 We welcome [pull requests](https://help.github.com/articles/about-pull-requests/) from anyone interested in contributing to `pkgnet`. This section describes best practices for submitting PRs to this project.
@@ -61,6 +64,7 @@ To submit a PR, please follow these steps:
 
 We will try to review PRs promptly and get back to you within a few days.
 
+***
 ## Code Style <a name="style"></a>
 
 The code in this project should follow a standard set of conventions for style in R code.
@@ -80,7 +84,7 @@ some_function <- function(n){
 }
 ```
 
-You do not need to namespace special operators in the case where doing so would hurt readablility. For example, `%>%` from `magrittr` and `:=` from `data.table` do not need `::` namespacing.
+You do not need to namespace special operators in the case where doing so would hurt readability. For example, `%>%` from `magrittr` and `:=` from `data.table` do not need `::` namespacing.
 
 If you are adding new dependencies to the package (i.e. using an entirely new package), you need to also add that dependency to the `Imports` section of the [DESCRIPTION file](https://github.com/UptakeOpenSource/pkgnet/blob/master/DESCRIPTION).
 
@@ -237,6 +241,7 @@ RandomNumberPlotter <- R6::R6Class(
 
 All comments should be above code, not beside it.
 
+***
 ## Running Tests Locally <a name="testing"></a>
 
 We use Travis CI to automatically run unit tests and a serious of other automated checks on every PR commit and merge to `master`. Every `pkgnet` release also goes through a battery of automated tests run on CRAN before becoming officially available through CRAN.
@@ -246,7 +251,27 @@ However, these options can lengthen your testing cycle and make the process of c
 ```{bash}
 ./test.sh
 ```
+***
+## Package Versioning <a name="version"></a>
 
+### Version Format
+We follow semantic versioning for `pkgnet` releases, `MAJOR`.`MINOR`.`PATCH`: 
+
+* the `MAJOR` version will be updated when incompatible API changes are made,   
+* the `MINOR` version will be updated when functionality is added in a backwards-compatible manner, and  
+* the `PATCH` version will be updated when backwards-compatible bug fixes are made.   
+
+In addition, the latest development version will have a .9999 appended to the end of the `MAJOR`.`MINOR`.`PATCH`. 
+
+For more details, see https://semver.org/
+
+### Release Planning
+The authors of this package have adopted [milestones on github](https://help.github.com/en/articles/about-milestones) as a vehile to scope and schedule upcoming releases.  The main goal for a release is written in the milestone description.  Then, any ideas, specific functionality, bugs, etcs submitted as [issues](https://help.github.com/en/articles/about-issues) pertinent to that goal are tagged for that milestone.  Goals for milestone are dicsused openly via a github issue.  
+
+Past and upcoming releases can be seen on the  [pkgnet milestones page](https://github.com/UptakeOpenSource/pkgnet/milestones). 
+
+
+***
 ## Releasing to CRAN (for maintainer) <a name="cran"></a>
 
 Once substantial time has passed or significant changes have been made to `pkgnet`, a new release should be pushed to [CRAN](https://cran.r-project.org). 
@@ -259,11 +284,11 @@ This is a manual process, with the following steps.
 
 Open a PR with a branch name `release/v0.0.0` (replacing 0.0.0 with the actual version number).
 
-Add a section for this release to `NEWS.md`.  This file details the new features, changes, and bug fixes that occured since the last version.  
+Add a section for this release to `NEWS.md`.  This file details the new features, changes, and bug fixes that occurred since the last version.  
 
 Add a section for this release to `cran-comments.md`. This file holds details of our submission comments to CRAN and their responses to our submissions.  
 
-Change the `Version:` field in `DESCRIPTION` to the official version you want on CRAN (should not have a trailing `.9000`).
+Change the `Version:` field in `DESCRIPTION` to the official version you want on CRAN (should not have a trailing `.9999`).
 
 Rebuild the documentation by running:
 
@@ -277,6 +302,10 @@ Rscript -e "pkgdown::build_site()"
 
 Check in whichever of the files generated by `pkgdown` seem relevant to you. Anything that shows up as "modified" when you run `git status` should be checked in to the PR branch. New files ("not tracked by git") should be considered on a case-by-case basis.
 
+### Test on latest development version of R (i.e. "R-Devel") 
+
+This is a CRAN requirement.  [This docker based process](https://alexandereckert.com/post/testing-r-packages-with-latest-r-devel/) from Alexander Eckert is very useful.
+
 ### Submit to CRAN
 
 Build the package tarball by running the following
@@ -301,7 +330,7 @@ Once the submission is accepted, great! Update `cran-comments.md` and merge the
 
 We use [the releases section](https://github.com/UptakeOpenSource/pkgnet/releases) in the repo to categorize certain important commits as release checkpoints. This makes it easier for developers to associate changes in the source code with the release history on CRAN, and enables features like `devtools::install_github()` for old versions.
 
-Navigate to https://github.com/UptakeOpenSource/pkgnet/releases/new. Click the dropdown in the "target" section, then click "recent commits". Choose the latest commit for the release PR you just merged. This will automatically create a [git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) on that commit and tell Github which revision to build when people ask for a given release.
+Navigate to https://github.com/UptakeOpenSource/pkgnet/releases/new. Click the drop down in the "target" section, then click "recent commits". Choose the latest commit for the release PR you just merged. This will automatically create a [git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) on that commit and tell Github which revision to build when people ask for a given release.
 
 Add some notes explaining what has changed since the previous release.
 

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: pkgnet
 Type: Package
 Title: Get Network Representation of an R Package
-Version: 0.3.2.9999
+Version: 0.4.0
 Authors@R: c(
     person("Brian", "Burns", email = "[email protected]", role = c("aut", "cre")),
     person("James", "Lamb", email = "[email protected]", role = c("aut")),

NEWS.md

@@ -1,4 +1,4 @@
-# pkgnet 0.3.2.9999 (current dev)
+# pkgnet 0.4.0
 
 ## NEW FEATURES
 

R/CreatePackageVignette.R

@@ -4,11 +4,11 @@
 #'    vignette can be rendered into a standard HTML vignette with the
 #'    \code{\link[knitr:vignette_engines]{knitr::rmarkdown}} vignette engine
 #'    into HTML vignettes upon package building. It is also compatible with
-#'    \code{\link[pkgdown:build_articles]{pkgdown}} sites. See the vignette
-#'    \href{https://cran.r-project.org/web/packages/pkgnet/vignettes/publishing-reports.html}{
+#'    #'    \code{\link[pkgdown:build_articles]{pkgdown}} sites. See the vignette
+#'    \href{https://uptakeopensource.github.io/pkgnet/articles/publishing-reports.html}{
 #'    "Publishing Your pkgnet Package Report"} for details about how to use this
 #'    function, as well as
-#'    \href{https://cran.r-project.org/web/packages/pkgnet/vignettes/pkgnet-report.html}{
+#'    \href{https://uptakeopensource.github.io/pkgnet-gallery/exhibits/pkgnet-vignette/pkgnet-vignette.html}{
 #'    our example for pkgnet}.
 #' @param pkg (string) path to root directory of package of interest
 #' @param pkg_reporters (list) a list of initialized package reporters

cran-comments.md

@@ -1,5 +1,34 @@
 # CRAN Submission History
 
+## v 0.4.0
+
+### Submission on April 1st, 2019
+This is a minor release that adds vignette creation functionality and makes a number of other minor changes and bug fixes.  Please see `NEWS.md` for details.
+
+As always, issues are tracked and source code is maintained at https://github.com/UptakeOpenSource/pkgnet.
+
+### CRAN Response on April 2nd, 2019
+Thanks, we see:
+
+   Found the following (possibly) invalid URLs:
+   ...
+   [two in the CreatePackageVignette()]
+   [one in NEWS.md]
+   ...
+
+Please fix and resubmit.
+
+
+Is there some reference about the method you can add in the Description 
+field in the form Authors (year) <doi:.....>?
+
+### Resubmission on April 5th, 2019
+The one remaining "possibly invalid URL" is intended.  That page will be created as soon as this version is on CRAN.  [Here](https://github.com/UptakeOpenSource/pkgnet/blob/929b2c3ee456870dd92e6a164f858a2b014c5e89/docs/articles/publishing-reports.html) it is queued up on github, awaiting CRAN release before merge. 
+
+The two were non-canonical CRAN links have been reformatted.  I had seen the warnings for the non-canonical CRAN links during testing and had interpreted them as optional.  In future testing, these CRAN link formatting warnings will be interpreted as required. 
+
+Regarding the references comment, the package is original work aside from the functionality utilized from the packages listed in the DESCRIPTION file. 
+
 ## v 0.3.2 
 
 ### Submission on January 25th, 2019
@@ -12,7 +41,7 @@ CHANGES
 * Revised unit test setup and teardown files to enable devtools::test() to work as well as CRAN server testing ([#167](https://github.com/UptakeOpenSource/pkgnet/pull/167))   
 
 BUG FIXES  
-* Corrected node statisitcs table merging error ([#165](https://github.com/UptakeOpenSource/pkgnet/issues/165), [#166](https://github.com/UptakeOpenSource/pkgnet/pull/166))   
+* Corrected node statistics table merging error ([#165](https://github.com/UptakeOpenSource/pkgnet/issues/165), [#166](https://github.com/UptakeOpenSource/pkgnet/pull/166))   
 * Added a NAMESPACE entry for knitr to suppress warning on CRAN server checks ([#168](https://github.com/UptakeOpenSource/pkgnet/pull/168))   
 
 
@@ -39,7 +68,7 @@ BUG FIXES
 ## v 0.3.0  
 
 ### Submission on December 19th, 2018
-> This is a major release with several improvements to 
+> This is a major[sic] release with several improvements to 
 > R package diagnostics, report layout, and testing 
 > strategy.  New features and changes are now being 
 > tracked in NEWS.md.  
@@ -135,7 +164,7 @@ Check: CRAN incoming feasibility, Result: Note_to_CRAN_maintainers
 ## v 0.2.0
 
 ### Submission on April 30th, 2018
-* Resubmitted to CRAN without test folder or source vigette code.
+* Resubmitted to CRAN without test folder or source vignette code.
 * This was to ensure nothing is written outside of the temp folder 
 during vignette build or package testing.  
 * Future versions will handle this issue more directly.