groovy-extensions/groovy-git/src/docs/asciidoc/isAncestorOf.adoc
2021-11-09 10:53:57 +01:00

30 lines
706 B
Text

= isAncestorOf
== Name
isAncestorOf - Tell if a commit is an ancestor of another.
== Synopsis
[source, groovy]
----
git.isAncestorOf(<base commit>, <tip commit>)
----
== Description
Given a base commit and a tip commit, return `true` if the base commit can be reached by walking back from the tip.
== Options
1. (`Object`) base commit. For a more complete list of objects you can pass in, see link:resolve.html[resolve] (specifically the `toCommit` method).
1. (`Object`) tip commit. For a more complete list of objects you can pass in, see link:resolve.html[resolve] (specifically the `toCommit` method).
== Examples
[source, groovy]
----
git.isAncestorOf('v1.2.3', 'master')
----
== See Also