Skip to content

Commit e5ca74a

Browse files
committed
docs: add commit_stats docs
Signed-off-by: Miguel Molina <[email protected]>
1 parent 9934354 commit e5ca74a

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
66

77
## [Unreleased]
88

9+
### Added
10+
11+
- Added documentation about `commit_stats`.
12+
13+
### Changed
14+
15+
- internal/function: gracefully handle errors in commit_stats.
16+
917
### Fixed
1018

1119
- internal/function: take into account if repository is resolved in commit_stats ([#863](https://github.com/src-d/gitbase/pull/863))

docs/using-gitbase/functions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ To make some common tasks easier for the user, there are some functions to inter
66

77
| Name | Description |
88
|:-------------|:-------------------------------------------------------------------------------------------------------------------------------|
9+
|`commit_stats(repository_id, [from_commit_hash], to_commit_hash)`|returns the stats between two commits for a repository. If from is empty, it will compare the given `to_commit_hash` with its parent commit|
910
|`is_remote(reference_name)bool`| check if the given reference name is from a remote one |
1011
|`is_tag(reference_name)bool`| check if the given reference name is a tag |
1112
|`is_vendor(file_path)bool`| check if the given file name is a vendored file |

0 commit comments

Comments
 (0)