Expublish.Git (expublish v2.6.0) View Source

Shell commands for git.

Link to this section Summary

Functions

commit_and_tag(version, options \\ %Options{}, syscall_module \\ System)

Create a git commit and tag for given %Version{}.

push(version, options \\ %Options{}, syscall_module \\ System)

Git push to remote.

validate(options \\ %Options{}, syscall_module \\ System)

Validate state of git working directory.

Link to this section Functions

commit_and_tag(version, options \\ %Options{}, syscall_module \\ System)

Specs

commit_and_tag(Version.t(), Expublish.Options.t(), module()) :: Version.t()

Create a git commit and tag for given %Version{}.

push(version, options \\ %Options{}, syscall_module \\ System)

Specs

push(
  Version.t(),
  %Expublish.Options{
    allow_untracked: term(),
    as_major: term(),
    as_minor: term(),
    branch: term(),
    changelog_date_time: term(),
    commit_prefix: term(),
    disable_publish: term(),
    disable_push: term(),
    disable_test: term(),
    dry_run: term(),
    help: term(),
    remote: term(),
    tag_prefix: term(),
    version_file: term()
  },
  module()
) :: Version.t()

Git push to remote.

validate(options \\ %Options{}, syscall_module \\ System)

Specs

validate(Expublish.Options.t(), module()) :: :ok | String.t()

Validate state of git working directory.

Returns :ok or error message.