GitHub Issues v0.2.2 GitHub.Issues
Fetches a list of issues from a GitHub project.
Summary
Functions
Fetches issues from a GitHub project
of a given user
Returns a URL based on user
and project
Types
Functions
Fetches issues from a GitHub project
of a given user
.
Returns a tuple of either {:ok, [issue]}
or {:error, text}
.
Parameters
user
- GitHub userproject
- GitHub projectoptions
- URL template (keyword)
Options
:url_template
- defaults to config for:url_template
(string)
Examples
alias GitHub.Issues
Issues.fetch("laravel", "elixir")
Returns a URL based on user
and project
.
Parameters
url_template
- URL templateuser
- userproject
- project
Examples
iex> alias GitHub.Issues
iex> app = Mix.Project.config[:app]
iex> url_template = Application.get_env app, :url_template
iex> Issues.url url_template, "laravel", "elixir"
"https://api.github.com/repos/laravel/elixir/issues"
iex> alias GitHub.Issues
iex> url_template = "elixir-lang.org/<project>/{user}/wow"
iex> Issues.url url_template, "José", "Elixir"
"elixir-lang.org/Elixir/José/wow"