Peace/doc/lib/Peace/Model/Release.pm.html

132 lines
3.9 KiB
HTML

<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Peace::Model::Release - The release object representation.</title>
<meta content="text/html; charset=utf-8" http-equiv="content-type" />
<link href="mailto:Alpine@build-edge-aarch64.nonet" rev="made" />
</head>
<body>
<ul id="index">
<li><a href="#NAME">NAME</a></li>
<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#INSTANCE-METHODS">INSTANCE METHODS</a>
<ul>
<li><a href="#new">new</a></li>
</ul>
</li>
<li><a href="#METHODS">METHODS</a>
<ul>
<li><a href="#generate_build">generate_build</a></li>
<li><a href="#uuid">uuid</a></li>
<li><a href="#date_creation">date_creation</a></li>
<li><a href="#application">application</a></li>
<li><a href="#tag">tag</a></li>
<li><a href="#name">name</a></li>
</ul>
</li>
<li><a href="#SEE-ALSO">SEE ALSO</a></li>
</ul>
<h1 id="NAME">NAME</h1>
<p>Peace::Model::Release - The release object representation.</p>
<h1 id="SYNOPSIS">SYNOPSIS</h1>
<pre><code>my $release = Peace::Model::Release-&gt;new(
application =&gt; $application,
tag =&gt; $tag,
name =&gt; $name,
);</code></pre>
<h1 id="DESCRIPTION">DESCRIPTION</h1>
<p>Describes a release from an application from Peace.</p>
<h1 id="INSTANCE-METHODS">INSTANCE METHODS</h1>
<p>Peace::Model::Release implements the following instance methods:</p>
<h2 id="new">new</h2>
<pre><code>my $release = Peace::Model::Release-&gt;new(
uuid =&gt; $uuid, # optional
date_creation =&gt; $date_creation, # optional
application =&gt; $application, # required or application_uuid should be passed.
application_uuid =&gt; $application_uuid, # required or application should be passed
dbh =&gt; $dbh, # needed if application_uuid is passed
tag =&gt; $tag,
name =&gt; $name,
);</code></pre>
<h1 id="METHODS">METHODS</h1>
<p>Peace::Model::Release implements the following methods:</p>
<h2 id="generate_build">generate_build</h2>
<p>my $result = $release-&gt;generate_build( arch =&gt; $arch );</p>
<p>my ($success, $output) = @result{&#39;success&#39;, &#39;output&#39;};</p>
<p>Generates a build for a given arch of the release and returns the success status, any false value failed, any true value succeded and the output which combines stdout and stderr from the ran commands and some application specific data about whats being done.</p>
<p>The output log is thought to be human consumed, not automatically parsed.</p>
<h2 id="uuid">uuid</h2>
<pre><code>my $uuid = $release-&gt;uuid;
$release-&gt;uuid($uuid);</code></pre>
<p>Allows to retrieve and set the release uuid.</p>
<h2 id="date_creation">date_creation</h2>
<pre><code>my $date_creation = $release-&gt;date_creation;
$release-&gt;date_creation($date_creation);</code></pre>
<p>Allows to retrieve and set the release date creation as a <a href="https://metacpan.org/pod/DateTime">DateTime</a>.</p>
<h2 id="application">application</h2>
<pre><code>my $application = $release-&gt;application;
$release-&gt;application($application);</code></pre>
<p>Allows to retrieve and set the release application as a <a href="Application.pm.html">Peace::Model::Application</a>.</p>
<h2 id="tag">tag</h2>
<pre><code>my $tag = $release-&gt;tag;
$release-&gt;tag($tag);</code></pre>
<p>Allows to retrieve and set the release tag.</p>
<h2 id="name">name</h2>
<pre><code>my $name = $release-&gt;name
$release-&gt;name($name);</code></pre>
<p>Allows to retrieve and set the release name.</p>
<h1 id="SEE-ALSO">SEE ALSO</h1>
<p><a href="Application.pm.html">Peace::Model::Application</a>, <a href="../DAO/Release.pm.html">Peace::DAO::Release</a></p>
</body>
</html>