bump to v0.1.1

Author: statnmap

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: gitdown
 Title: Turn Your Git Commit Messages into a HTML Book
-Version: 0.1.0
+Version: 0.1.1
 Authors@R: 
     c(person(given = "Sébastien",
              family = "Rochette",
@@ -22,7 +22,7 @@ Description: Read all commit messages of your local git repository and
     organisms required to testify for every changes in their source code,
     in relation to features requests.
 License: MIT + file LICENSE
-URL: https://thinkr-open.github.io/gitdown,
+URL: https://thinkr-open.github.io/gitdown/,
     https://github.com/Thinkr-open/gitdown
 BugReports: https://github.com/Thinkr-open/gitdown/issues
 Depends: 

NEWS.md

@@ -1,3 +1,7 @@
+# gitdown 0.1.1
+
+* Improve documentation
+
 # gitdown 0.1.0
 
 * Get ready for CRAN

R/git_down.R

@@ -28,17 +28,20 @@
 #' repo <- fake_repo()
 #' res <- git_down(repo, pattern = c("Tickets" = "ticket[[:digit:]]+", "Issues" = "#[[:digit:]]+"),
 #' open = FALSE)
+#' \dontrun{
 #' # Open the book
-#' # browseURL(res)
-#'
+#'   browseURL(res)
+#' }
 #' # With table of correspondence
 #' pattern.table <- data.frame(number = c("#2", "#1"),
 #'   title = c("#2 A second issue to illustrate a blog post",
 #'                        "#1 An example of issue"))
 #' res <- git_down(repo, pattern = c("Issues" = "#[[:digit:]]+"),
 #'   pattern.table = pattern.table, open = FALSE)
+#' \dontrun{
 #' # Open the book
-#' # browseURL(res)
+#'   browseURL(res)
+#' }
 
 git_down <- function(repo = ".", book_path = "gitdown",
                      open = TRUE, author = "John Doe",

README.Rmd

@@ -34,7 +34,7 @@ Full documentation on {pkgdown} site : https://thinkr-open.github.io/gitdown/ind
 
 ## Installation
 
-You can install the last version of {gitdown} from Github:
+You can install the last version of {gitdown} from GitHub:
 
 ``` r
 remotes::install_github("ThinkR-open/gitdown")
@@ -70,7 +70,7 @@ knitr::include_graphics("reference/figures/gitdown_links.png")
 ```
 
 If you add a table of correspondence, you can change titles of the patterns.  
-_Note that you can use [{gitlabr}](https://statnmap.github.io/gitlabr/) or [{gh}](https://gh.r-lib.org) to retrieve list of issues from Gitlab or Github respectively, as presented in ["Download Gitlab or Github issues and make a summary report of your commits"](https://rtask.thinkr.fr/download-gitlab-or-github-issues-and-make-a-summary-report-of-your-commits/)._  
+_Note that you can use [{gitlabr}](https://statnmap.github.io/gitlabr/) or [{gh}](https://gh.r-lib.org) to retrieve list of issues from GitLab or GitHub respectively, as presented in ["Download GitLab or GitHub issues and make a summary report of your commits"](https://rtask.thinkr.fr/download-gitlab-or-github-issues-and-make-a-summary-report-of-your-commits/)._  
 
 ```{r, eval=FALSE}
 # With table of correspondence

README.md

@@ -21,7 +21,7 @@ Full documentation on {pkgdown} site :
 
 ## Installation
 
-You can install the last version of {gitdown} from Github:
+You can install the last version of {gitdown} from GitHub:
 
 ``` r
 remotes::install_github("ThinkR-open/gitdown")
@@ -64,8 +64,8 @@ git_down(repo, pattern = c("Tickets" = "ticket[[:digit:]]+",
 If you add a table of correspondence, you can change titles of the
 patterns.  
 *Note that you can use [{gitlabr}](https://statnmap.github.io/gitlabr/)
-or [{gh}](https://gh.r-lib.org) to retrieve list of issues from Gitlab
-or Github respectively, as presented in [“Download Gitlab or Github
+or [{gh}](https://gh.r-lib.org) to retrieve list of issues from GitLab
+or GitHub respectively, as presented in [“Download GitLab or GitHub
 issues and make a summary report of your
 commits”](https://rtask.thinkr.fr/download-gitlab-or-github-issues-and-make-a-summary-report-of-your-commits/).*
 
@@ -103,13 +103,13 @@ get_commits_pattern(repo, pattern = "#[[:digit:]]+", ref = "master") %>%
 #> # A tibble: 7 x 12
 #>   pattern.content sha    summary message  author email when                order
 #>   <chr>           <chr>  <chr>   <chr>    <chr>  <chr> <dttm>              <int>
-#> 1 #32             7c1aa… Add NE… "Add NE… Alice  alic… 2021-05-08 17:29:32     4
-#> 2 #1              7c1aa… Add NE… "Add NE… Alice  alic… 2021-05-08 17:29:32     4
-#> 3 #12             7c1aa… Add NE… "Add NE… Alice  alic… 2021-05-08 17:29:32     4
-#> 4 #2              a0285… Third … "Third … Alice  alic… 2021-05-08 17:29:32     3
-#> 5 #145            a0285… Third … "Third … Alice  alic… 2021-05-08 17:29:32     3
-#> 6 #1              fe750… exampl… "exampl… Alice  alic… 2021-05-08 17:29:32     2
-#> 7 <NA>            4fe03… First … "First … Alice  alic… 2021-05-08 17:29:32     1
+#> 1 #32             e66cf… Add NE… "Add NE… Alice  alic… 2021-05-08 18:00:01     4
+#> 2 #1              e66cf… Add NE… "Add NE… Alice  alic… 2021-05-08 18:00:01     4
+#> 3 #12             e66cf… Add NE… "Add NE… Alice  alic… 2021-05-08 18:00:01     4
+#> 4 #2              cebbb… Third … "Third … Alice  alic… 2021-05-08 18:00:01     3
+#> 5 #145            cebbb… Third … "Third … Alice  alic… 2021-05-08 18:00:01     3
+#> 6 #1              934b8… exampl… "exampl… Alice  alic… 2021-05-08 18:00:01     2
+#> 7 <NA>            1ba16… First … "First … Alice  alic… 2021-05-08 18:00:01     1
 #> # … with 4 more variables: tag.name <chr>, tag.message <chr>,
 #> #   pattern.type <chr>, pattern.title <chr>
 ```
@@ -128,18 +128,18 @@ get_commits_pattern(
 #> # A tibble: 12 x 12
 #>    pattern.type pattern.content sha       summary   message        author email 
 #>    <chr>        <chr>           <chr>     <chr>     <chr>          <chr>  <chr> 
-#>  1 Tickets      ticket6789      7c1aace9… Add NEWS  "Add NEWS\n\n… Alice  alice…
-#>  2 Tickets      ticket1234      7c1aace9… Add NEWS  "Add NEWS\n\n… Alice  alice…
-#>  3 Issues       #32             7c1aace9… Add NEWS  "Add NEWS\n\n… Alice  alice…
-#>  4 Issues       #1              7c1aace9… Add NEWS  "Add NEWS\n\n… Alice  alice…
-#>  5 Issues       #12             7c1aace9… Add NEWS  "Add NEWS\n\n… Alice  alice…
-#>  6 Tickets      <NA>            a028509a… Third co… "Third commit… Alice  alice…
-#>  7 Issues       #2              a028509a… Third co… "Third commit… Alice  alice…
-#>  8 Issues       #145            a028509a… Third co… "Third commit… Alice  alice…
-#>  9 Tickets      ticket1234      fe750dfe… example:… "example: mod… Alice  alice…
-#> 10 Issues       #1              fe750dfe… example:… "example: mod… Alice  alice…
-#> 11 Tickets      <NA>            4fe0392f… First co… "First commit… Alice  alice…
-#> 12 Issues       <NA>            4fe0392f… First co… "First commit… Alice  alice…
+#>  1 Tickets      ticket6789      e66cf6b1… Add NEWS  "Add NEWS\n\n… Alice  alice…
+#>  2 Tickets      ticket1234      e66cf6b1… Add NEWS  "Add NEWS\n\n… Alice  alice…
+#>  3 Issues       #32             e66cf6b1… Add NEWS  "Add NEWS\n\n… Alice  alice…
+#>  4 Issues       #1              e66cf6b1… Add NEWS  "Add NEWS\n\n… Alice  alice…
+#>  5 Issues       #12             e66cf6b1… Add NEWS  "Add NEWS\n\n… Alice  alice…
+#>  6 Tickets      <NA>            cebbb5e9… Third co… "Third commit… Alice  alice…
+#>  7 Issues       #2              cebbb5e9… Third co… "Third commit… Alice  alice…
+#>  8 Issues       #145            cebbb5e9… Third co… "Third commit… Alice  alice…
+#>  9 Tickets      ticket1234      934b8178… example:… "example: mod… Alice  alice…
+#> 10 Issues       #1              934b8178… example:… "example: mod… Alice  alice…
+#> 11 Tickets      <NA>            1ba16a26… First co… "First commit… Alice  alice…
+#> 12 Issues       <NA>            1ba16a26… First co… "First commit… Alice  alice…
 #> # … with 5 more variables: when <dttm>, order <int>, tag.name <chr>,
 #> #   tag.message <chr>, pattern.title <chr>
 ```
@@ -158,9 +158,9 @@ With this example, the vignette will show this content:
 
 | File         | Tracked in git | Date of creation    | Last modification   |
 |:-------------|:---------------|:--------------------|:--------------------|
-| NEWS.md      | Yes            | 2021-05-08 19:29:33 | 2021-05-08 19:29:33 |
-| example.txt  | Yes            | 2021-05-08 19:29:33 | 2021-05-08 19:29:33 |
-| R/my\_mean.R | No             | NA                  | 2021-05-08 19:29:33 |
+| NEWS.md      | Yes            | 2021-05-08 20:00:01 | 2021-05-08 20:00:01 |
+| example.txt  | Yes            | 2021-05-08 20:00:01 | 2021-05-08 20:00:01 |
+| R/my\_mean.R | No             | NA                  | 2021-05-08 20:00:01 |
 
 ## Sponsor
 

dev_history.R

@@ -67,9 +67,16 @@ usethis::use_github_action("test-coverage")
 
 
 # CRAN
-usethis::use_release_issue(version = "0.1.1")
+devtools::build_readme()
+urlchecker::url_check()
+urlchecker::url_update()
+
+# usethis::use_release_issue(version = "0.1.1")
+usethis::use_version('patch')
+
 rcmdcheck::rcmdcheck(args = "--as-cran")
 spelling::spell_check_package()
+rhub::validate_email()
 rhub::check_for_cran()
 rhub::check_on_windows(check_args = "--force-multiarch")
 rhub::check_on_fedora()