Versioce.Git (Versioce v1.1.2) View Source

Git utility functions for versioce module.

Link to this section Summary

Functions

add(args \\ ["."])

Stage files.

commit(message)

Make a commit with a message.

get_commit_messages_in_range(hash1, hash2)

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

get_message_from_hash(hash)

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()

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

initial_commit()

Get initial commit hash.

repo()

Get git repository.

tag(name, message)

Create a tag.

Link to this section Functions

add(args \\ ["."])

Specs

add([String.t()]) :: String.t()

Stage files.

commit(message)

Specs

commit(String.t()) :: String.t()

Make a commit with a message.

get_commit_messages_in_range(hash1, hash2)

Specs

get_commit_messages_in_range(String.t(), String.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)

Specs

get_message_from_hash(String.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()

Specs

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

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

initial_commit()

Specs

initial_commit() :: String.t()

Get initial commit hash.

repo()

Specs

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

Get git repository.

tag(name, message)

Specs

tag(String.t(), String.t()) :: String.t()

Create a tag.