Versioce.Git (Versioce v2.0.0) View Source

Git utility functions for versioce module.

Link to this section Summary

Functions

add(args \\ ["."], repo \\ repo())

Stage files.

commit(message, repo \\ repo())

Make a commit with a message.

get_commit_messages_in_range(hash1, hash2, repo \\ repo())

Get a list of messages from hash1 to hash2 in %{hash: "Commmit hash", message: "Commit message"} format

get_message_from_hash(hash, repo \\ repo())

Get message of a commit by its hash.

get_tag_name(version_name)

Generate tag name according to Versioce.Config.Git.tag_template/0.

get_tags(repo \\ repo())

Returns a list of tags in %{hash: "Commmit hash", tag: "Tag name"} format

initial_commit(repo \\ repo())

Get initial commit hash.

repo()

Get git repository.

tag(name, message, params \\ [], repo \\ repo())

Create a tag.

Link to this section Functions

add(args \\ ["."], repo \\ repo())

Specs

add([String.t()], Git.Repository.t()) :: String.t()

Stage files.

commit(message, repo \\ repo())

Specs

commit(String.t(), Git.Repository.t()) :: String.t()

Make a commit with a message.

get_commit_messages_in_range(hash1, hash2, repo \\ repo())

Specs

get_commit_messages_in_range(String.t(), String.t(), Git.Repository.t()) :: [
  %{hash: String.t(), message: String.t()}
]

Get a list of messages from hash1 to hash2 in %{hash: "Commmit hash", message: "Commit message"} format

get_message_from_hash(hash, repo \\ repo())

Specs

get_message_from_hash(String.t(), Git.Repository.t()) :: String.t()

Get message of a commit by its hash.

get_tag_name(version_name)

Specs

get_tag_name(String.t()) :: String.t()

Generate tag name according to Versioce.Config.Git.tag_template/0.

get_tags(repo \\ repo())

Specs

get_tags(Git.Repository.t()) :: [%{hash: String.t(), tag: String.t()}]

Returns a list of tags in %{hash: "Commmit hash", tag: "Tag name"} format

initial_commit(repo \\ repo())

Specs

initial_commit(Git.Repository.t()) :: String.t()

Get initial commit hash.

repo()

Specs

repo() :: Git.Repository.t()

Get git repository.

tag(name, message, params \\ [], repo \\ repo())

Specs

tag(String.t(), String.t(), [String.t()], Git.Repository.t()) :: String.t()

Create a tag.