Skip to content

Commit

Permalink
docs: updates from Homebrew/brew
Browse files Browse the repository at this point in the history
  • Loading branch information
BrewTestBot committed May 14, 2024
1 parent ddd4e00 commit 860c130
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 20 deletions.
56 changes: 37 additions & 19 deletions docs/Homebrew/Attestation.html
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,11 @@



<dl>
<dt>Extended by:</dt>
<dd><span class='object_link'><a href="../SystemCommand/Mixin.html" title="SystemCommand::Mixin (module)">SystemCommand::Mixin</a></span></dd>
</dl>




Expand Down Expand Up @@ -287,6 +292,17 @@ <h2>











<h3 class="inherited">Methods included from <span class='object_link'><a href="../SystemCommand/Mixin.html" title="SystemCommand::Mixin (module)">SystemCommand::Mixin</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../SystemCommand/Mixin.html#system_command-instance_method" title="SystemCommand::Mixin#system_command (method)">system_command</a></span>, <span class='object_link'><a href="../SystemCommand/Mixin.html#system_command!-instance_method" title="SystemCommand::Mixin#system_command! (method)">system_command!</a></span></p>


<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
Expand Down Expand Up @@ -428,9 +444,6 @@ <h3 class="signature first" id="check_attestation-class_method">
<pre class="lines">


73
74
75
76
77
78
Expand Down Expand Up @@ -466,13 +479,17 @@ <h3 class="signature first" id="check_attestation-class_method">
108
109
110
111</pre>
111
112
113
114
115</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'attestation.rb', line 73</span>
<pre class="code"><span class="info file"># File 'attestation.rb', line 76</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_check_attestation'>check_attestation</span><span class='lparen'>(</span><span class='id identifier rubyid_bottle'>bottle</span><span class='comma'>,</span> <span class='id identifier rubyid_signing_repo'>signing_repo</span><span class='comma'>,</span> <span class='id identifier rubyid_signing_workflow'>signing_workflow</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_subject'>subject</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_cmd'>cmd</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_gh_executable'>gh_executable</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>attestation</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>verify</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_bottle'>bottle</span><span class='period'>.</span><span class='id identifier rubyid_cached_download'>cached_download</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--repo</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_signing_repo'>signing_repo</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--format</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
<span class='id identifier rubyid_cmd'>cmd</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>attestation</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>verify</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_bottle'>bottle</span><span class='period'>.</span><span class='id identifier rubyid_cached_download'>cached_download</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--repo</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_signing_repo'>signing_repo</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--format</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>json</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>

<span class='id identifier rubyid_cmd'>cmd</span> <span class='op'>+=</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--cert-identity</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_signing_workflow'>signing_workflow</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_signing_workflow'>signing_workflow</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span>
Expand All @@ -484,7 +501,8 @@ <h3 class="signature first" id="check_attestation-class_method">
<span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="Attestation/GhAuthNeeded.html" title="Homebrew::Attestation::GhAuthNeeded (class)">GhAuthNeeded</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>missing credentials</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span>

<span class='kw'>begin</span>
<span class='id identifier rubyid_output'>output</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Utils.html" title="Utils (module)">Utils</a></span></span><span class='period'>.</span><span class='id identifier rubyid_safe_popen_read'><span class='object_link'><a href="../Utils.html#safe_popen_read-class_method" title="Utils.safe_popen_read (method)">safe_popen_read</a></span></span><span class='lparen'>(</span><span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>GH_TOKEN</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_credentials'>credentials</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_cmd'>cmd</span><span class='rparen'>)</span>
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='id identifier rubyid_system_command!'>system_command!</span><span class='lparen'>(</span><span class='id identifier rubyid_gh_executable'>gh_executable</span><span class='comma'>,</span> <span class='label'>args:</span> <span class='id identifier rubyid_cmd'>cmd</span><span class='comma'>,</span> <span class='label'>env:</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>GH_TOKEN</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_credentials'>credentials</span> <span class='rbrace'>}</span><span class='comma'>,</span>
<span class='label'>secrets:</span> <span class='lbracket'>[</span><span class='id identifier rubyid_credentials'>credentials</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>rescue</span> <span class='const'><span class='object_link'><a href="../ErrorDuringExecution.html" title="ErrorDuringExecution (class)">ErrorDuringExecution</a></span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='comment'># Even if we have credentials, they may be invalid or malformed.
</span> <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="Attestation/GhAuthNeeded.html" title="Homebrew::Attestation::GhAuthNeeded (class)">GhAuthNeeded</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>invalid credentials</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_exitstatus'>exitstatus</span> <span class='op'>==</span> <span class='int'>4</span>
Expand All @@ -493,7 +511,7 @@ <h3 class="signature first" id="check_attestation-class_method">
<span class='kw'>end</span>

<span class='kw'>begin</span>
<span class='id identifier rubyid_attestations'>attestations</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_output'>output</span><span class='rparen'>)</span>
<span class='id identifier rubyid_attestations'>attestations</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_stdout'>stdout</span><span class='rparen'>)</span>
<span class='kw'>rescue</span> <span class='const'>JSON</span><span class='op'>::</span><span class='const'>ParserError</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="Attestation/InvalidAttestationError.html" title="Homebrew::Attestation::InvalidAttestationError (class)">InvalidAttestationError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>attestation verification returned malformed JSON</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
Expand Down Expand Up @@ -610,10 +628,6 @@ <h3 class="signature " id="check_core_attestation-class_method">
<pre class="lines">


124
125
126
127
128
129
130
Expand Down Expand Up @@ -645,10 +659,14 @@ <h3 class="signature " id="check_core_attestation-class_method">
156
157
158
159</pre>
159
160
161
162
163</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'attestation.rb', line 124</span>
<pre class="code"><span class="info file"># File 'attestation.rb', line 128</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_check_core_attestation'>check_core_attestation</span><span class='lparen'>(</span><span class='id identifier rubyid_bottle'>bottle</span><span class='rparen'>)</span>
<span class='kw'>begin</span>
Expand Down Expand Up @@ -734,17 +752,17 @@ <h3 class="signature " id="gh_executable-class_method">
<pre class="lines">


46
47
48
49
50
51
52
53</pre>
53
54
55
56</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'attestation.rb', line 46</span>
<pre class="code"><span class="info file"># File 'attestation.rb', line 49</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_gh_executable'>gh_executable</span>
<span class='comment'># NOTE: We disable HOMEBREW_VERIFY_ATTESTATIONS when installing `gh` itself,
Expand Down
Loading

0 comments on commit 860c130

Please sign in to comment.