Skip to content

Commit

Permalink
Deployed 339cfe5 to main with MkDocs 1.5.3 and mike 2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed May 21, 2024
1 parent f028b18 commit 8fd84aa
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 34 deletions.
43 changes: 11 additions & 32 deletions main/deploying/ContainerImagesAndGithubActions/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2310,22 +2310,18 @@ <h2 id="image">Image<a class="headerlink" href="#image" title="Permanent link">&
<h3 id="tags">Tags<a class="headerlink" href="#tags" title="Permanent link">&para;</a></h3>
<p>ACA-Py is a foundation for building decentralized identity applications; to this
end, there are multiple variants of ACA-Py built to suit the needs of a variety
of environments and workflows. There are currently two main variants:</p>
of environments and workflows. The following variants exist:</p>
<ul>
<li>"Standard" - The default configuration of ACA-Py, including:</li>
<li>Aries Askar for secure storage</li>
<li>Indy VDR for Indy ledger communication</li>
<li>Indy Shared Libraries for AnonCreds</li>
<li>"Indy" - The legacy configuration of ACA-Py, including:</li>
<li>Indy SDK Wallet for secure storage</li>
<li>Indy SDK Ledger for Indy ledger communication</li>
<li>Indy SDK for AnonCreds</li>
</ul>
<p>These two image variants are largely distinguished by providers for Indy Network
and AnonCreds support. The Standard variant is recommended for new projects.
Migration from an Indy based image (whether the new Indy image variant or the
original BC Gov images) to the Standard image is outside of the scope of this
document.</p>
<p>In the past, two image variants were published. These two variants are largely
distinguished by providers for Indy Network and AnonCreds support. The Standard
variant is recommended for new projects. Migration from an Indy based image
(whether the new Indy image variant or the original BC Gov images) to the
Standard image is outside of the scope of this document.</p>
<p>The ACA-Py images built by this project are tagged to indicate which of the
above variants it is. Other tags may also be generated for use by developers.</p>
<p>Below is a table of all generated images and their tags:</p>
Expand All @@ -2351,18 +2347,6 @@ <h3 id="tags">Tags<a class="headerlink" href="#tags" title="Permanent link">&par
<td>py3.10-0.7.4</td>
<td>Standard image variant built on Python 3.10 for ACA-Py version X.Y.Z</td>
</tr>
<tr>
<td>py3.9-indy-A.B.C-X.Y.Z</td>
<td>Indy</td>
<td>py3.9-indy-1.16.0-0.7.4</td>
<td>Standard image variant built on Python 3.9 for ACA-Py version X.Y.Z and Indy SDK Version A.B.C</td>
</tr>
<tr>
<td>py3.10-indy-A.B.C-X.Y.Z</td>
<td>Indy</td>
<td>py3.10-indy-1.16.0-0.7.4</td>
<td>Standard image variant built on Python 3.10 for ACA-Py version X.Y.Z and Indy SDK Version A.B.C</td>
</tr>
</tbody>
</table>
<h3 id="image-comparison">Image Comparison<a class="headerlink" href="#image-comparison" title="Permanent link">&para;</a></h3>
Expand All @@ -2376,7 +2360,7 @@ <h3 id="image-comparison">Image Comparison<a class="headerlink" href="#image-com
<li>Uses container's system python environment rather than <code>pyenv</code></li>
<li>Askar and Indy Shared libraries are installed as dependencies of ACA-Py through pip from pre-compiled binaries included in the python wrappers</li>
<li>Built from repo contents</li>
<li>Indy Image</li>
<li>Indy Image (no longer produced but included here for clarity)</li>
<li>Based on slim variant of Debian</li>
<li>Built from multi-stage build step (<code>indy-base</code> in the Dockerfile) which includes Indy dependencies; this could be replaced with an explicit <code>indy-python</code> image from the Indy SDK repo</li>
<li>Includes <code>libindy</code> but does <strong>NOT</strong> include the Indy CLI</li>
Expand All @@ -2399,21 +2383,16 @@ <h2 id="github-actions">Github Actions<a class="headerlink" href="#github-action
<ul>
<li>Tests (<code>.github/workflows/tests.yml</code>) - A reusable workflow that runs tests
for the Standard ACA-Py variant for a given python version.</li>
<li>Tests (Indy) (<code>.github/workflows/tests-indy.yml</code>) - A reusable workflow that
runs tests for the Indy ACA-Py variant for a given python and indy version.</li>
<li>PR Tests (<code>.github/workflows/pr-tests.yml</code>) - Run on pull requests; runs tests
for the Standard and Indy ACA-Py variants for a "default" python version.
Check this workflow for the current default python and Indy versions in use.</li>
for the Standard ACA-Py variant for a "default" python version.
Check this workflow for the current default python version in use.</li>
<li>Nightly Tests (<code>.github/workflows/nightly-tests.yml</code>) - Run nightly; runs
tests for the Standard and Indy ACA-Py variants for all currently supported
tests for the Standard ACA-Py variant for all currently supported
python versions. Check this workflow for the set of currently supported
versions and Indy version(s) in use.</li>
versions in use.</li>
<li>Publish (<code>.github/workflows/publish.yml</code>) - Run on new release published or
when manually triggered; builds and pushes the Standard ACA-Py variant to the
Github Container Registry.</li>
<li>Publish (Indy) (<code>.github/workflows/publish-indy.yml</code>) - Run on new release
published or when manually triggered; builds and pushes the Indy ACA-Py
variant to the Github Container Registry.</li>
<li>Integration Tests (<code>.github/workflows/integrationtests.yml</code>) - Run on pull
requests (to the hyperledger fork only); runs BDD integration tests.</li>
<li>Black Format (<code>.github/workflows/blackformat.yml</code>) - Run on pull requests;
Expand Down
2 changes: 1 addition & 1 deletion main/search/search_index.json

Large diffs are not rendered by default.

Binary file modified main/sitemap.xml.gz
Binary file not shown.
2 changes: 1 addition & 1 deletion main/testing/UnitTests/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2508,7 +2508,7 @@ <h2 id="other-details">Other details<a class="headerlink" href="#other-details"
</li>
<li>
<p>pytest.mark setup in <code>setup.cfg</code>
can be attributed at function or class level. Example, <code>@pytest.mark.indy</code></p>
can be attributed at function or class level. Example, <code>@pytest.mark.askar</code></p>
</li>
<li>
<p>Code coverage
Expand Down

0 comments on commit 8fd84aa

Please sign in to comment.