Aura.Releases (Aura v0.9.1)

View Source

Service module for interacting with Hex package releases

Summary

Types

The reason for retiring a release

Functions

Permanently deletes associated documentation for a release

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

retire_reason()

@type retire_reason() :: :renamed | :security | :invalid | :deprecated | :other

The reason for retiring a release

Functions

delete_release(package_name, version, opts \\ [])

@spec delete_release(
  package_name :: Aura.Common.package_name(),
  version :: Aura.Common.release_version(),
  opts :: list()
) :: :ok | {:error, any()}

Permanently deletes a release

delete_release_docs(package_name, version, opts \\ [])

@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

get_release(package_name, version, opts \\ [])

@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

get_release_docs(package_name, version, opts \\ [])

@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

publish_release(release_code_tar, opts \\ [])

@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

publish_release_docs(package_name, release_version, doc_tar, opts \\ [])

@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

retire_release(package_name, version, reason \\ :other, message, opts \\ [])

@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

undo_retire_release(package_name, version, opts \\ [])

@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