@spec api_base_url() :: String.t()

api_base_url/0 returns the Gitea Server REST API url for API requests.

examples

Examples

iex> Gitea.Helpers.api_base_url() "https://gitea-server.fly.dev/api/v1/"

@spec create_local_path([String.t()]) :: binary()

Returns the full system path

@spec get_org_name_from_url(String.t()) :: String.t()

get_org_name_from_url/1 extracts the organisation name from a .git url. ssh://git@gitea-server.fly.dev:10022/theorg/myrepo.git

@spec get_org_repo_names(String.t()) :: {String.t(), String.t()}

returns {org, repo} from git url

examples

Examples

iex> Gitea.Helpers.get_org_repo_names("git@gitea-server.fly.dev:myorg/myrepo.git") {"myorg", "myrepo"}

iex> Gitea.Helpers.get_org_repo_names("ssh://git@gitea-server.fly.dev:10022/theorg/myrepo.git") {"theorg", "myrepo"}

iex> Gitea.Helpers.get_org_repo_names("https://gitea-server.fly.dev/myorg/public-repo.git") {"myorg", "public-repo"}

@spec get_repo_name_from_url(String.t()) :: String.t()

get_repo_name_from_url/1 extracts the repository name from a .git url. Feel free to refactor/simplify this function if you want.

@spec local_git_repo(String.t(), String.t()) :: Git.Repository.t()

local_git_repo/2 returns the %Git.Repository{} (struct) for an org and repo on the localhost. This is used by the Git module to perform operations.

@spec local_repo_path(String.t(), String.t()) :: binary()

local_repo_path/2 returns the full system path for the cloned repo on the localhost i.e. the Elixir/Phoenix server that cloned it.

@spec make_url(String.t()) :: String.t()

make_url/1 constructs the URL based on the supplied git url.

examples

Examples

iex> Gitea.Helpers.make_url("gitea-server.fly.dev") "git@gitea-server.fly.dev:"

iex> Gitea.Helpers.make_url("github.com") "git@github.com:"

@spec remote_url(String.t(), String.t(), String.t()) :: String.t()

remote_url/3 returns the git remote url.

@spec remote_url_ssh(String.t(), String.t()) :: String.t()

remote_url_ssh/2 returns the remote ssh url for cloning.

@spec temp_dir(any()) :: binary()

temp_dir/1 returns the Current Working Directory (CWD). Made this a function in case we want to change the location of the directory later e.g. to a temporary directory.