Liking cljdoc? Tell your friends :D

fr.jeremyschoffen.mbt.alpha.core.git

Api providing git utilities. Mostly a wrapper for some functionality from clj-jgit.

Api providing git utilities. Mostly a wrapper for some functionality from `clj-jgit`.
      
raw docstring

add!clj

(add! {repo :fr.jeremyschoffen.mbt.alpha.git/repo
       addition :fr.jeremyschoffen.mbt.alpha.git/add!})

Git add operation using [[clj-jgit.porcelain/git-add]]. The parameter and options are specified under the key ::fr...mbt.alpha.git/add!.

Git add operation using [[clj-jgit.porcelain/git-add]]. The parameter and options are specified under the key
`::fr...mbt.alpha.git/add!`.
sourceraw docstring

add-all!clj

(add-all! param)

Use the git add operation on all patterns listed by fr.jeremyschoffen.mbt.alpha.core.git/list-all-changed-patterns. In effect stages modified and un-tracked files.

Use the git add operation on all patterns listed by
[[fr.jeremyschoffen.mbt.alpha.core.git/list-all-changed-patterns]]. In effect stages modified and un-tracked files.
sourceraw docstring

any-commit?clj

(any-commit? {repo :fr.jeremyschoffen.mbt.alpha.git/repo})

Test whether the git repo has any commits or not.

Test whether the git repo has any commits or not.
sourceraw docstring

commit!clj

(commit! {repo :fr.jeremyschoffen.mbt.alpha.git/repo
          commit :fr.jeremyschoffen.mbt.alpha.git/commit!})

Commit to a git repo using [[clj-jgit.porcelain/git-commit]]. The options to the porcelain function are passed in the git/commit map, see the :fr...mbt.alpha.git/commit! spec.

Commit to a git repo using [[clj-jgit.porcelain/git-commit]].
The options to the porcelain function are passed in the git/commit map,
see the `:fr...mbt.alpha.git/commit!` spec.
sourceraw docstring

DatafyJGitcljprotocol

datafy-jgit*clj

(datafy-jgit* x)
source

describeclj

(describe {repo :fr.jeremyschoffen.mbt.alpha.git/repo :as param})

Get a git description in a map form. This is an evolved version of fr.jeremyschoffen.mbt.alpha.core.git/describe-raw with additional data.

See the spec :fr...mbt.alpha.git/description.

Get a git description in a map form. This is an evolved version of
[[fr.jeremyschoffen.mbt.alpha.core.git/describe-raw]] with additional data.

See the spec `:fr...mbt.alpha.git/description`.
sourceraw docstring

describe-rawclj

(describe-raw {repo :fr.jeremyschoffen.mbt.alpha.git/repo
               tag-pattern
                 :fr.jeremyschoffen.mbt.alpha.git.describe/tag-pattern})

Get a git description.

Similar to:

git describe --long --match tag-pattern

tag-pattern being the value passed under the key :fr...mbt.alpha.git.describe/tag-pattern.

Can return nil if there are no tag matching the pattern or no tags at all.

Get a git description.

Similar to:
```
git describe --long --match tag-pattern
```
`tag-pattern` being the value passed under the key `:fr...mbt.alpha.git.describe/tag-pattern`.

Can return nil if there are no tag matching the pattern or no tags at all.
sourceraw docstring

dirty?clj

(dirty? {repo :fr.jeremyschoffen.mbt.alpha.git/repo})

Test whether the git repo is dirty or not.

Test whether the git repo is dirty or not.
sourceraw docstring

get-tagclj

(get-tag {repo :fr.jeremyschoffen.mbt.alpha.git/repo
          tag-name :fr.jeremyschoffen.mbt.alpha.git.tag/name})

Get a git tag using its name. The original jgit object is accessible via metadata under the key :jgit/object.

Get a git tag using its name. The original jgit object is accessible via metadata under the key `:jgit/object`.
sourceraw docstring

last-commitclj

(last-commit {repo :fr.jeremyschoffen.mbt.alpha.git/repo})

Returns the last commit made on the current branch, the first commit to pop up in the git log.

Returns the last commit made on the current branch, the first commit to pop up in
the git log.
sourceraw docstring

list-all-changed-patternsclj

(list-all-changed-patterns param)

Make a list of strings taken from the :modified and :untracked sections of a git status.

See: status

Make a list of strings taken from the `:modified` and `:untracked` sections of a git status.

See: [[status]]
sourceraw docstring

make-jgit-repoclj

(make-jgit-repo param)

Builds a org.eclipse.jgit.api.Git object.

Builds a `org.eclipse.jgit.api.Git` object.
sourceraw docstring

prefixclj

(prefix {wd :fr.jeremyschoffen.mbt.alpha.project/working-dir :as context})

Given the project's working dir, find the git prefix.

Similar to using:

git -C wd/ rev-parse --show-prefix
Given the project's working dir, find the git prefix.

Similar to using:
```bash
git -C wd/ rev-parse --show-prefix
```
sourceraw docstring

raw-description-regexclj

Regex used to parse a git raw description.

Regex used to parse a git raw description.
sourceraw docstring

statusclj

(status {repo :fr.jeremyschoffen.mbt.alpha.git/repo})

Get the status of the current repo via [[clj-jgit.porcelain/git-status]].

Get the status of the current repo via [[clj-jgit.porcelain/git-status]].
sourceraw docstring

tag!clj

(tag! {repo :fr.jeremyschoffen.mbt.alpha.git/repo :as param})

Create a new git tag using [[clj-jgit.porcelain/git-tag-create]].

See the :fr...mbt.alpha.git/tag! specs for all the options.

Create a new git tag using [[clj-jgit.porcelain/git-tag-create]].

See the `:fr...mbt.alpha.git/tag!` specs for all the options.
sourceraw docstring

top-levelclj

(top-level {wd :fr.jeremyschoffen.mbt.alpha.project/working-dir})

Given the project's working dir, find the git top level.

Similar to using:

git -C wd/ rev-parse --show-toplevel
Given the project's working dir, find the git top level.

Similar to using:
```bash
git -C wd/ rev-parse --show-toplevel
```
sourceraw docstring

update-all!clj

(update-all! param)

Similar to fr.jeremyschoffen.mbt.alpha.core.git/add-all! but uses the :fr...mbt.alpha.git.add!/update? option set to true.

Similar to [[fr.jeremyschoffen.mbt.alpha.core.git/add-all!]] but uses the `:fr...mbt.alpha.git.add!/update?`
option set to `true`.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close