Aura.Releases (Aura v0.9.1)
View SourceService module for interacting with Hex package releases
Summary
Types
The reason for retiring a release
Functions
Permanently deletes a release
Permanently deletes associated documentation for a release
Returns a Aura.Model.HexRelease
for a given package / version
Returns the contents of the release's docs tar.gz
Publishes a release .tar packaged by a build tool to a Hex-compliant repository
Publishes associated release docs tar.gz to a Hex-compliant repository
Marks a release as retired, signaling to others that it should not be used
Removes the retired status from a release, signaling to others that it can still be used
Types
Functions
@spec delete_release( package_name :: Aura.Common.package_name(), version :: Aura.Common.release_version(), opts :: list() ) :: :ok | {:error, any()}
Permanently deletes a release
@spec delete_release_docs( package_name :: Aura.Common.package_name(), version :: Aura.Common.release_version(), opts :: list() ) :: :ok | {:error, any()}
Permanently deletes associated documentation for a release
@spec get_release( package_name :: Aura.Common.package_name(), version :: Aura.Common.release_version(), opts :: list() ) :: {:ok, Aura.Model.HexRelease.t()} | {:error, any()}
Returns a Aura.Model.HexRelease
for a given package / version
@spec get_release_docs( package_name :: Aura.Common.package_name(), version :: Aura.Common.release_version(), opts :: list() ) :: {:ok, Aura.PackageTarUtil.tar_contents()} | {:error, any()}
Returns the contents of the release's docs tar.gz
@spec publish_release( release_code_tar :: String.t(), opts :: list() ) :: {:ok, Aura.Model.HexRelease.t()} | {:error, any()}
Publishes a release .tar packaged by a build tool to a Hex-compliant repository
@spec publish_release_docs( package_name :: Aura.Common.package_name(), release_version :: Aura.Common.release_version(), doc_tar :: String.t(), opts :: list() ) :: {:ok, URI.t()} | {:error, any()}
Publishes associated release docs tar.gz to a Hex-compliant repository
@spec retire_release( package_name :: Aura.Common.package_name(), version :: Aura.Common.release_version(), reason :: retire_reason(), message :: String.t(), opts :: list() ) :: :ok | {:error, any()}
Marks a release as retired, signaling to others that it should not be used
@spec undo_retire_release( package_name :: Aura.Common.package_name(), version :: Aura.Common.release_version(), opts :: list() ) :: :ok | {:error, any()}
Removes the retired status from a release, signaling to others that it can still be used