Skip to content

Commit

Permalink
Update unreleased documentation (#567)
Browse files Browse the repository at this point in the history
* Update versions.json

* Deployed 1dd545a to unreleased in versions with MkDocs 1.5.3 and mike 2.0.0

* Sort docs versions

---------

Co-authored-by: GitHub Actions Bot <[email protected]>
  • Loading branch information
github-actions[bot] and GitHub Actions Bot authored Jan 16, 2024
1 parent bafb4fc commit 0cf6c3f
Show file tree
Hide file tree
Showing 6 changed files with 237 additions and 238 deletions.
12 changes: 6 additions & 6 deletions versions/unreleased/api-ref/prefect/flows/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11101,7 +11101,7 @@ <h2 id="prefect.flows.Flow" class="doc doc-heading">
<span class="sd"> my_flow()</span>
<span class="sd"> ```</span>

<span class="sd"> Load a flow from a private git repository:</span>
<span class="sd"> Load a flow from a private git repository using an access token stored in a `Secret` block:</span>

<span class="sd"> ```python</span>
<span class="sd"> from prefect import flow</span>
Expand All @@ -11111,7 +11111,7 @@ <h2 id="prefect.flows.Flow" class="doc doc-heading">
<span class="sd"> my_flow = flow.from_source(</span>
<span class="sd"> source=GitRepository(</span>
<span class="sd"> url=&quot;https://github.com/org/repo.git&quot;,</span>
<span class="sd"> access_token=Secret.load(&quot;github-access-token&quot;).get(),</span>
<span class="sd"> credentials={&quot;access_token&quot;: Secret.load(&quot;github-access-token&quot;)}</span>
<span class="sd"> ),</span>
<span class="sd"> entrypoint=&quot;flows.py:my_flow&quot;,</span>
<span class="sd"> )</span>
Expand Down Expand Up @@ -12339,15 +12339,15 @@ <h3 id="prefect.flows.Flow.from_source" class="doc doc-heading">

<span class="n">my_flow</span><span class="p">()</span>
</code></pre></div>
<p>Load a flow from a private git repository:</p>
<p>Load a flow from a private git repository using an access token stored in a <code>Secret</code> block:</p>
<div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">prefect</span> <span class="kn">import</span> <span class="n">flow</span>
<span class="kn">from</span> <span class="nn">prefect.runner.storage</span> <span class="kn">import</span> <span class="n">GitRepository</span>
<span class="kn">from</span> <span class="nn">prefect.blocks.system</span> <span class="kn">import</span> <span class="n">Secret</span>

<span class="n">my_flow</span> <span class="o">=</span> <span class="n">flow</span><span class="o">.</span><span class="n">from_source</span><span class="p">(</span>
<span class="n">source</span><span class="o">=</span><span class="n">GitRepository</span><span class="p">(</span>
<span class="n">url</span><span class="o">=</span><span class="s2">&quot;https://github.com/org/repo.git&quot;</span><span class="p">,</span>
<span class="n">access_token</span><span class="o">=</span><span class="n">Secret</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s2">&quot;github-access-token&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">get</span><span class="p">(),</span>
<span class="n">credentials</span><span class="o">=</span><span class="p">{</span><span class="s2">&quot;access_token&quot;</span><span class="p">:</span> <span class="n">Secret</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="s2">&quot;github-access-token&quot;</span><span class="p">)}</span>
<span class="p">),</span>
<span class="n">entrypoint</span><span class="o">=</span><span class="s2">&quot;flows.py:my_flow&quot;</span><span class="p">,</span>
<span class="p">)</span>
Expand Down Expand Up @@ -12467,7 +12467,7 @@ <h3 id="prefect.flows.Flow.from_source" class="doc doc-heading">
<span class="sd"> my_flow()</span>
<span class="sd"> ```</span>

<span class="sd"> Load a flow from a private git repository:</span>
<span class="sd"> Load a flow from a private git repository using an access token stored in a `Secret` block:</span>

<span class="sd"> ```python</span>
<span class="sd"> from prefect import flow</span>
Expand All @@ -12477,7 +12477,7 @@ <h3 id="prefect.flows.Flow.from_source" class="doc doc-heading">
<span class="sd"> my_flow = flow.from_source(</span>
<span class="sd"> source=GitRepository(</span>
<span class="sd"> url=&quot;https://github.com/org/repo.git&quot;,</span>
<span class="sd"> access_token=Secret.load(&quot;github-access-token&quot;).get(),</span>
<span class="sd"> credentials={&quot;access_token&quot;: Secret.load(&quot;github-access-token&quot;)}</span>
<span class="sd"> ),</span>
<span class="sd"> entrypoint=&quot;flows.py:my_flow&quot;,</span>
<span class="sd"> )</span>
Expand Down
4 changes: 2 additions & 2 deletions versions/unreleased/api-ref/prefect/runner/storage/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9268,7 +9268,7 @@ <h2 id="prefect.runner.storage.GitRepository" class="doc doc-heading">
<tr>
<td><code>credentials</code></td>
<td>
<code><span title="typing.Union">Union</span>[<span title="prefect.runner.storage.GitCredentials">GitCredentials</span>, <a class="autorefs autorefs-internal" title="prefect.blocks.core.Block" href="../../blocks/core/#prefect.blocks.core.Block">Block</a>, None]</code>
<code><span title="typing.Union">Union</span>[<span title="prefect.runner.storage.GitCredentials">GitCredentials</span>, <a class="autorefs autorefs-internal" title="prefect.blocks.core.Block" href="../../blocks/core/#prefect.blocks.core.Block">Block</a>, <span title="typing.Dict">Dict</span>[str, <span title="typing.Any">Any</span>], None]</code>
</td>
<td>
<div class="doc-md-description">
Expand Down Expand Up @@ -9606,7 +9606,7 @@ <h2 id="prefect.runner.storage.GitRepository" class="doc doc-heading">
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">url</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="n">credentials</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">GitCredentials</span><span class="p">,</span> <span class="n">Block</span><span class="p">,</span> <span class="kc">None</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">credentials</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">GitCredentials</span><span class="p">,</span> <span class="n">Block</span><span class="p">,</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">],</span> <span class="kc">None</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">name</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">branch</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">include_submodules</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
Expand Down
1 change: 0 additions & 1 deletion versions/unreleased/guides/prefect-deploy/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9492,7 +9492,6 @@ <h3 id="store-your-code-in-git-based-cloud-storage">Store your code in git-based
Generally, you can just push your code to GitHub, without rebuilding your deployment.
The exception is if something that the server needs to know about changes, such as the flow entrypoint parameters.
Rerunning the Python script with <code>.deploy</code> will update your deployment on the server with the new flow code.</p>
<p>If you want to pull your flow code from private git-based storage,</p>
<p>If you need to provide additional configuration, such as specifying a private repository, you can provide a <a href="/api-ref/prefect/flows/#prefect.runner.storage.GitRepository"><code>GitRepository</code></a> object instead of a URL:</p>
<div class="highlight"><span class="filename">private_git_storage.py</span><pre><span></span><code><span class="kn">from</span> <span class="nn">prefect</span> <span class="kn">import</span> <span class="n">flow</span>
<span class="hll"><span class="kn">from</span> <span class="nn">prefect.runner.storage</span> <span class="kn">import</span> <span class="n">GitRepository</span>
Expand Down
2 changes: 1 addition & 1 deletion versions/unreleased/search/search_index.json

Large diffs are not rendered by default.

Loading

0 comments on commit 0cf6c3f

Please sign in to comment.