Liking cljdoc? Tell your friends :D

automaton-build.code.vcs

Version Control System.

Proxy to git.

Version Control System.

Proxy to [git](https://git-scm.com/book/en/v2).
raw docstring

clean-hard-cmdclj

(clean-hard-cmd)
(clean-hard-cmd interactive?)

Returns the command to clean the project as it has came back to the same state than the repository is freshly downloaded.

Use interactive?=false with caution!!!!! (default to true) to ask user confirmation.

Returns the command to clean the project as it has came back to the same state than the repository is freshly downloaded.

Use `interactive?`=false with caution!!!!! (default to true) to ask user confirmation.
raw docstring

clean-stateclj

(clean-state)

Returns a command to detect clean state

Returns a command to detect clean state
raw docstring

clean-state-analyzeclj

(clean-state-analyze res)

Check if the returned value of clean state

Check if the returned value of clean state 
raw docstring

clone-file-chain-cmdclj

(clone-file-chain-cmd repo-url target-dir branch-name file-name)

Returns a map with:

  • file-path where file will be stored.
  • chain-cmd: Chain of command to clone the repo at repo-url into the target-dir () specific file with it's latest revision.

It's quick as it ignores all other files, all other branches of the repository and git history.

Returns a map with:

* `file-path` where file will be stored.
* `chain-cmd`: Chain of command to clone the repo at `repo-url` into the `target-dir` () specific file with it's latest revision.

It's quick as it ignores all other files, all other branches of the repository and git history.
raw docstring

commit-analyzeclj

(commit-analyze {:keys [cmd-str out] :as res})

Analyze the first failing command to tell if it is the commit, and if the commit was succesful.

  • Adds :nothing-to-commit when this is the case.
  • Adds :is-commit
Analyze the first failing command to tell if it is the commit, and if the commit was succesful.

* Adds `:nothing-to-commit` when this is the case.
* Adds `:is-commit`
raw docstring

commit-chain-cmdclj

(commit-chain-cmd msg)

Returns a chain of commands to commit all changes in the repo int dir, under the message msg.

Returns a chain of commands to commit all changes in the repo int `dir`, under the message `msg`.
raw docstring

current-branch-analyzeclj

(current-branch-analyze cmd-res)

Return the current branch from one res returned value.

Return the current branch from one `res` returned value.
raw docstring

current-branch-cmdclj

(current-branch-cmd)

Returns a command to get the name of the current branch.

Returns a command to get the name of the current branch.
raw docstring

find-git-repoclj

(find-git-repo dir)

Search a git repo in dir of its parent directories.

Search a git repo in `dir` of its parent directories.
raw docstring

git-changes?-analyzeclj

(git-changes?-analyze cmd-res)

Returns true if directory dir is under version control and has pending changes.

Returns `true` if directory `dir` is under version control and has pending changes.
raw docstring

git-changes?-cmdclj

(git-changes?-cmd)

Returns true if directory dir is under version control and has pending changes.

Returns `true` if directory `dir` is under version control and has pending changes.
raw docstring

git-setup-dirclj

(git-setup-dir repo-dir)

Returns the hidden .git directory of app in repo repo-dir

Returns the hidden `.git` directory of app in repo `repo-dir`
raw docstring

latest-commit-message-cmdclj

(latest-commit-message-cmd)

Returns a command to get the commit message of the latest commit of the current branch.

Returns a command to get the commit message of the latest commit of the current branch.
raw docstring

latest-commit-sha-cmdclj

(latest-commit-sha-cmd)

Returns a command to get the current commit sha for the current branch.

Returns a command to get the current commit sha for the current branch.
raw docstring

merge-cmdclj

(merge-cmd branch1 branch2)

Merges branch1 into branch2

Merges `branch1` into `branch2`
raw docstring

new-branch-and-switch-chain-cmdclj

(new-branch-and-switch-chain-cmd branch-name)

Returns a command

Returns a command 
raw docstring

one-commit-push-chain-cmdclj

(one-commit-push-chain-cmd ssh-url branch msg)

Push content of directory repo-dir in branch branch, and in one commit to repo ssh-url.

Push content of directory `repo-dir` in branch `branch`, and in one commit to repo `ssh-url`.
raw docstring

pull-changes-chain-cmdclj

(pull-changes-chain-cmd branch)

Returns a command to fetch and pull changes from origin.

Returns a command to fetch and pull changes from `origin`.
raw docstring

push-analyzeclj

(push-analyze {:keys [err] :as res})

Analyze the res of the push-cmd to add :nothing-to-do if no commit was to be pushed.

Analyze the `res` of the `push-cmd` to add `:nothing-to-do` if no commit was to be pushed.
raw docstring

push-cmdclj

(push-cmd branch-name force?)

Returns a command to push the local commits of the repo where the command is executed for the branch branch-name.

If force? is true, the push even if commit are conflicting with the remote branch.

Returns a command to push the local commits of the repo where the command is executed for the branch `branch-name`.

If `force?` is `true`, the push even if commit are conflicting with the remote branch.
raw docstring

remote-branch-exists?clj

(remote-branch-exists? remote-branches local-branch)

Is the local-branch exists on the remote repository at `repo-url.

Is the `local-branch` exists on the remote repository at `repo-url.
raw docstring

remote-branchesclj

(remote-branches chain-res)

remote-branches-chain-cmdclj

(remote-branches-chain-cmd repo-url)

Returns the remote branches for a repo at repo-url.

Returns the remote branches for a repo at `repo-url`.
raw docstring

repo-url-regexpclj

(repo-url-regexp)

Regexp to validate a repo-url.

Regexp to validate a `repo-url`.
raw docstring

shallow-clone-repo-branch-analyzeclj

(shallow-clone-repo-branch-analyze cmd-res)

Adds to the cmd-res keys :inexisting-remote-branch if the repo does not exist, or :inexisting-remote-branch if the branch does not exist.

Adds to the `cmd-res` keys `:inexisting-remote-branch` if the repo does not exist, or `:inexisting-remote-branch` if the branch does not exist.
raw docstring

shallow-clone-repo-branch-cmdclj

(shallow-clone-repo-branch-cmd repo-url)
(shallow-clone-repo-branch-cmd repo-url branch-name)
(shallow-clone-repo-branch-cmd repo-url branch-name cloned-dir-name)

Returns command to clone the repository at address repo-url for branch branch-name - only the result of the latest commit (i.e. shallow commit).

Returns command to clone the repository at address `repo-url` for branch `branch-name` - only the result of the latest commit (i.e. shallow commit). 
raw docstring

spit-hookclj

(spit-hook app-dir hook-name content)

Spit the content in the hook called hook-name of app-dir repo.

Spit the `content` in the hook called `hook-name` of `app-dir` repo.
raw docstring

tagclj

(tag version tag-msg)

Creates a tag under name version and message tag-msg.

Creates a tag under name `version` and message `tag-msg`.
raw docstring

tag-push-chain-cmdclj

(tag-push-chain-cmd branch-name dir version tag-msg force?)

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

× close