SkillKit.Kit.GitHub.Ref (SkillKit v0.1.0)

Copy Markdown View Source

Parses GitHub repository references in the format owner/repo[/path][@ref].

Summary

Types

t()

@type t() :: %SkillKit.Kit.GitHub.Ref{
  owner: String.t(),
  path: String.t() | nil,
  ref: String.t() | nil,
  repo: String.t()
}

Functions

allowed?(ref, patterns)

@spec allowed?(t(), String.t() | [String.t()]) :: boolean()

cache_key(ref)

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

display_name(ref)

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

parse(source)

@spec parse(String.t()) :: {:ok, t()} | {:error, :invalid_reference}