Create a gitbook with git_down

  collapse = TRUE,
  comment = "#>"

Create a reproducible example of a versioned directory

Create a versioned directory with some commits and a in a temporary directory

repo <- fake_repo()

Build book of commits messages

The main function of {gitdown} is to build this gitbook with all commit messages ordered according to a pattern. Each commit message associated with an issue will be recorded in the section of this issue. A commit message can thus appears multiple times if it is associated with multiple issues.
If you have your own referencing system for tickets in an external software, you can also create the gitbook associated like using ticket as in the example below.

git_down(repo, pattern = c("Tickets" = "ticket[[:digit:]]+", "Issues" = "#[[:digit:]]+"))

Read list of commits and extract information

As a side effect of {gitdown}, you can get some intermediate information used to build the book with some exported functions.

Get commits and find pattern

get_commits_tags(repo, ref = "main")
get_commits_pattern(repo, pattern = "#[[:digit:]]+", ref = "main")

Create a vignette that lists all files with date of modification

repo_pkg <- fake_repo(as.package = TRUE)
# List only files in R/ directory
# List all files of the git repository
create_vignette_last_modif(repo_pkg, path = "")

With this example, the vignette will show this content:

repo_pkg <- fake_repo(as.package = TRUE)
cat(present_files(repo_pkg, path = ""))

Try the gitdown package in your browser

Any scripts or data that you put into this service are public.

gitdown documentation built on March 18, 2022, 6:01 p.m.