Package: gitdown 0.1.6

Sébastien Rochette

gitdown: Turn Your Git Commit Messages into a HTML Book

Read all commit messages of your local git repository and sort them according to tags or specific text pattern into chapters of a HTML book using 'bookdown'. The git history book presentation helps organisms required to testify for every changes in their source code, in relation to features requests.

Authors:Sébastien Rochette [aut, cre], Cervan Girard [aut], ThinkR [cph], Institut de Recherches Internationales Servier [spn]

gitdown_0.1.6.tar.gz
gitdown_0.1.6.zip(r-4.7)gitdown_0.1.6.zip(r-4.6)gitdown_0.1.6.zip(r-4.5)
gitdown_0.1.6.tgz(r-4.6-any)gitdown_0.1.6.tgz(r-4.5-any)
gitdown_0.1.6.tar.gz(r-4.7-any)gitdown_0.1.6.tar.gz(r-4.6-any)
gitdown_0.1.6.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
gitdown/json (API)

# Install 'gitdown' in R:

install.packages('gitdown', repos = c('https://thinkr-open.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/thinkr-open/gitdown/issues

Pkgdown/docs site:https://thinkr-open.github.io

On CRAN:

bookdown git gitbook

5.96 score 35 stars 13 scripts 261 downloads 12 exports 44 dependencies

Last updated from:62de39c52a. Checks:9 OK. Indexed: yes.

Target	Result	Time
linux-devel-x86_64	OK	132
source / vignettes	OK	191
linux-release-x86_64	OK	153
macos-release-arm64	OK	121
macos-oldrel-arm64	OK	93
windows-devel	OK	89
windows-release	OK	111
windows-oldrel	OK	87
wasm-release	OK	114

Exports:%>%create_vignette_last_modif each_pattern fake_repo get_commits_pattern get_commits_tags get_info get_last_modif git_down nest_commits_by_pattern present_files update_vignette_last_modif

Dependencies:attempt base64enc bookdown bslib cachem cli cpp11 digest dplyr evaluate fastmap fontawesome fs generics git2r glue highr htmltools jquerylib jsonlite knitr lifecycle magrittr memoise mime pillar pkgconfig purrr R6 rappdirs rlang rmarkdown sass stringi stringr tibble tidyr tidyselect tinytex utf8 vctrs withr xfun yaml

Create a gitbook with git_down

Create a reproducible example of a versioned directory | Build book of commits messages | Read list of commits and extract information | Get commits and find pattern | Create a vignette that lists all files with date of modification

Rendered fromab-create-git_down.Rmdusingknitr::rmarkdown

Last update: 2022-03-04
Started: 2019-09-12

Citation

Development and contributors

Readme and manuals

Help Manual

Help page	Topics
Creates and updates a vignette in the 'vignette/' directory of a package with last modification time of tracked files	create_vignette_last_modif update_vignette_last_modif
Create the text to add in a markdown file to present each pattern as a chapter of the book	each_pattern
Create a fake git repository in a specific folder	fake_repo
Get commits associated with a text pattern	get_commits_pattern
Get commits associated chronologically with tags	get_commits_tags
Get the first and last modification time for a specific file, based on git2r::blame().	get_info
Get the first and last modification time of files of a directory	get_last_modif
Turns the active branch history of git into a bookdown.	git_down
Nest all commits by each pattern found in the commit messages	nest_commits_by_pattern
Presenting results of files and last modification time in a printed table using 'kable()'	present_files