Skip to content

Commit

Permalink
v0.1.1 on CRAN
Browse files Browse the repository at this point in the history
  • Loading branch information
@statnmap
statnmap committed May 10, 2021
1 parent ece45d4 commit d98a067
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 22 deletions.
1 change: 1 addition & 0 deletions README.Rmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ file.copy(list.files("reference/figures", full.names = TRUE),
<!-- badges: start -->
[![Coverage status](https://codecov.io/gh/ThinkR-open/gitdown/branch/master/graph/badge.svg)](https://codecov.io/github/ThinkR-open/gitdown?branch=master)
[![R-CMD-check](https://github.com/ThinkR-open/gitdown/workflows/R-CMD-check/badge.svg)](https://github.com/ThinkR-open/gitdown/actions)
[![CRAN status](https://www.r-pkg.org/badges/version/gitdown)](https://CRAN.R-project.org/package=gitdown)
<!-- badges: end -->

The goal of {gitdown} is to build a bookdown report of commit messages arranged according to a pattern. Book can be organized according to git tags, issues mentioned (*e.g.* `#123`) or any custom character chain included in your git commit messages (*e.g.* `category_` for use like `category_ui`, `category_doc`, ...).
Expand Down
46 changes: 24 additions & 22 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
[![Coverage
status](https://codecov.io/gh/ThinkR-open/gitdown/branch/master/graph/badge.svg)](https://codecov.io/github/ThinkR-open/gitdown?branch=master)
[![R-CMD-check](https://github.com/ThinkR-open/gitdown/workflows/R-CMD-check/badge.svg)](https://github.com/ThinkR-open/gitdown/actions)
[![CRAN
status](https://www.r-pkg.org/badges/version/gitdown)](https://CRAN.R-project.org/package=gitdown)
<!-- badges: end -->

The goal of {gitdown} is to build a bookdown report of commit messages
Expand Down Expand Up @@ -103,13 +105,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 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
#> 1 #32 1174c… Add NE… "Add NE… Alice alic… 2021-05-10 13:56:40 4
#> 2 #1 1174c… Add NE… "Add NE… Alice alic… 2021-05-10 13:56:40 4
#> 3 #12 1174c… Add NE… "Add NE… Alice alic… 2021-05-10 13:56:40 4
#> 4 #2 d4af8… Third … "Third … Alice alic… 2021-05-10 13:56:40 3
#> 5 #145 d4af8… Third … "Third … Alice alic… 2021-05-10 13:56:40 3
#> 6 #1 ebad8… exampl… "exampl… Alice alic… 2021-05-10 13:56:40 2
#> 7 <NA> 11c2e… First … "First … Alice alic… 2021-05-10 13:56:40 1
#> # … with 4 more variables: tag.name <chr>, tag.message <chr>,
#> # pattern.type <chr>, pattern.title <chr>
```
Expand All @@ -128,18 +130,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 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…
#> 1 Tickets ticket6789 1174cbe3… Add NEWS "Add NEWS\n\n… Alice alice…
#> 2 Tickets ticket1234 1174cbe3… Add NEWS "Add NEWS\n\n… Alice alice…
#> 3 Issues #32 1174cbe3… Add NEWS "Add NEWS\n\n… Alice alice…
#> 4 Issues #1 1174cbe3… Add NEWS "Add NEWS\n\n… Alice alice…
#> 5 Issues #12 1174cbe3… Add NEWS "Add NEWS\n\n… Alice alice…
#> 6 Tickets <NA> d4af8c93… Third co… "Third commit… Alice alice…
#> 7 Issues #2 d4af8c93… Third co… "Third commit… Alice alice…
#> 8 Issues #145 d4af8c93… Third co… "Third commit… Alice alice…
#> 9 Tickets ticket1234 ebad8089… example:… "example: mod… Alice alice…
#> 10 Issues #1 ebad8089… example:… "example: mod… Alice alice…
#> 11 Tickets <NA> 11c2e4a6… First co… "First commit… Alice alice…
#> 12 Issues <NA> 11c2e4a6… First co… "First commit… Alice alice…
#> # … with 5 more variables: when <dttm>, order <int>, tag.name <chr>,
#> # tag.message <chr>, pattern.title <chr>
```
Expand All @@ -158,9 +160,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 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 |
| NEWS.md | Yes | 2021-05-10 15:56:41 | 2021-05-10 15:56:41 |
| example.txt | Yes | 2021-05-10 15:56:41 | 2021-05-10 15:56:41 |
| R/my\_mean.R | No | NA | 2021-05-10 15:56:41 |

## Sponsor

Expand Down

0 comments on commit d98a067

Please sign in to comment.