Skip to contents

Get commits associated chronologically with tags

Source: R/get_commits.R
get_commits_tags.Rd

Get commits associated chronologically with tags

Usage

get_commits_tags(repo = ".", ref = "main", path = NULL, silent = FALSE)

Arguments

repo

a path to a repository or a git_repository object. Default is '.'

ref

The name of a reference to list commits from e.g. a tag or a branch. The default is NULL for the current branch.

path

The path to a file. If not NULL, only commits modifying this file will be returned. Note that modifying commits that occurred before the file was given its present name are not returned; that is, the output of git log with --no-follow is reproduced.

silent

Logical. Whether to hide messages.

Value

A tibble with one line for each commit and the following columns:

  • sha: sha of the commit

  • summary: First line of the commit message

  • message: Full content of the commit message

  • author: author of the commit

  • email: email of the author

  • when: commit time

  • order: order of commit messages. 1 is the oldest.

  • tag.name: name of tag associated with all commits since the last tag

  • tag.message: message of the tagged commit

Examples

repo <- fake_repo()
get_commits_tags(repo = repo)
#> 4 commits found.
#> # A tibble: 4 × 9
#>   sha            summary message author email when                order tag.name
#>   <chr>          <chr>   <chr>   <chr>  <chr> <dttm>              <int> <chr>   
#> 1 11e42f61382b3… Add NE… "Add N… Alice  alic… 2024-04-24 00:57:29     4 NA      
#> 2 8d16c2a0da5c8… Third … "Third… Alice  alic… 2024-04-24 00:57:29     3 v0.1    
#> 3 f8b6de4afde00… exampl… "examp… Alice  alic… 2024-04-24 00:57:29     2 v0.1    
#> 4 1e5070308db6f… First … "First… Alice  alic… 2024-04-24 00:57:29     1 v0.1    
#> # ℹ 1 more variable: tag.message <chr>