Skip to content

Commit

Permalink
Deployed 6e2e91e to main with MkDocs 1.6.1 and mike 2.1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Oct 15, 2024
1 parent 1ddfe45 commit e4f85f3
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 29 deletions.
50 changes: 26 additions & 24 deletions main/CHANGELOG/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -523,37 +523,37 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#110rc0" class="md-nav__link">
<a href="#110rc1" class="md-nav__link">
<span class="md-ellipsis">
1.1.0rc0
1.1.0rc1
</span>
</a>

<nav class="md-nav" aria-label="1.1.0rc0">
<nav class="md-nav" aria-label="1.1.0rc1">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#october-11-2024" class="md-nav__link">
<a href="#october-15-2024" class="md-nav__link">
<span class="md-ellipsis">
October 11, 2024
October 15, 2024
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#110rc0-deprecation-notices" class="md-nav__link">
<a href="#110rc1-deprecation-notices" class="md-nav__link">
<span class="md-ellipsis">
1.1.0rc0 Deprecation Notices
1.1.0rc1 Deprecation Notices
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#110rc0-breaking-changes" class="md-nav__link">
<a href="#110rc1-breaking-changes" class="md-nav__link">
<span class="md-ellipsis">
1.1.0rc0 Breaking Changes
1.1.0rc1 Breaking Changes
</span>
</a>

Expand Down Expand Up @@ -2635,37 +2635,37 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#110rc0" class="md-nav__link">
<a href="#110rc1" class="md-nav__link">
<span class="md-ellipsis">
1.1.0rc0
1.1.0rc1
</span>
</a>

<nav class="md-nav" aria-label="1.1.0rc0">
<nav class="md-nav" aria-label="1.1.0rc1">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#october-11-2024" class="md-nav__link">
<a href="#october-15-2024" class="md-nav__link">
<span class="md-ellipsis">
October 11, 2024
October 15, 2024
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#110rc0-deprecation-notices" class="md-nav__link">
<a href="#110rc1-deprecation-notices" class="md-nav__link">
<span class="md-ellipsis">
1.1.0rc0 Deprecation Notices
1.1.0rc1 Deprecation Notices
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#110rc0-breaking-changes" class="md-nav__link">
<a href="#110rc1-breaking-changes" class="md-nav__link">
<span class="md-ellipsis">
1.1.0rc0 Breaking Changes
1.1.0rc1 Breaking Changes
</span>
</a>

Expand Down Expand Up @@ -2992,14 +2992,14 @@


<h1 id="aries-cloud-agent-python-changelog">Aries Cloud Agent Python Changelog<a class="headerlink" href="#aries-cloud-agent-python-changelog" title="Permanent link">&para;</a></h1>
<h2 id="110rc0">1.1.0rc0<a class="headerlink" href="#110rc0" title="Permanent link">&para;</a></h2>
<h3 id="october-11-2024">October 11, 2024<a class="headerlink" href="#october-11-2024" title="Permanent link">&para;</a></h3>
<h2 id="110rc1">1.1.0rc1<a class="headerlink" href="#110rc1" title="Permanent link">&para;</a></h2>
<h3 id="october-15-2024">October 15, 2024<a class="headerlink" href="#october-15-2024" title="Permanent link">&para;</a></h3>
<p>Release 1.1.0 is the first release of ACA-Py from the <a href="https://openwallet.foundation/">OpenWallet Foundation</a> (OWF). The only reason for the release is to test out all of the release publishing actions now that we have moved the repo to its new home (<a href="https://github.com/openwallet-foundation/acapy">https://github.com/openwallet-foundation/acapy</a>). Almost all of the changes in the release are related to the move.</p>
<p>The move triggered some big changes for those with existing ACA-Py deployments resulting from the change in the GitHub organization (from Hyperledger to OWF) and source code name (from <code>aries_cloudagent</code> to <code>acapy_agent</code>). See the <a href="#110rc0-breaking-changes">Release 1.1.0 breaking changes</a> for the details.</p>
<p>For up to date details on what the repo move means for ACA-Py users, including steps for updating deployments, please follow the updates in <a href="https://github.com/hyperledger/aries-cloudagent-python/issues/3250">GitHub Issue #3250</a>. We'll keep you informed about the approach, timeline, and progress of the move. Stay tuned!</p>
<h3 id="110rc0-deprecation-notices">1.1.0rc0 Deprecation Notices<a class="headerlink" href="#110rc0-deprecation-notices" title="Permanent link">&para;</a></h3>
<h3 id="110rc1-deprecation-notices">1.1.0rc1 Deprecation Notices<a class="headerlink" href="#110rc1-deprecation-notices" title="Permanent link">&para;</a></h3>
<p>The same <strong><a href="#101-deprecation-notices">deprecation notices</a></strong> from the <a href="#101">1.0.1</a> release about AIP 1.0 protocols still apply. The protocols remain in the 1.1.0 release, but will be moved out of the core and into plugins soon. Please review these notifications carefully!</p>
<h3 id="110rc0-breaking-changes">1.1.0rc0 Breaking Changes<a class="headerlink" href="#110rc0-breaking-changes" title="Permanent link">&para;</a></h3>
<h3 id="110rc1-breaking-changes">1.1.0rc1 Breaking Changes<a class="headerlink" href="#110rc1-breaking-changes" title="Permanent link">&para;</a></h3>
<p>The only (but significant) breaking changes in 1.1.0 are related to the GitHub organization and project name changes. Specific impacts are:</p>
<ul>
<li>the renaming of the source code folder from <code>aries_cloudagent</code> to <code>acapy_agent</code>,</li>
Expand All @@ -3015,11 +3015,12 @@ <h3 id="110rc0-breaking-changes">1.1.0rc0 Breaking Changes<a class="headerlink"
<li>Deployments sourcing the ACA-Py published container image artifacts to <a href="https://ghcr.io">GHCR</a> must update their deployments to use the new URLs.</li>
</ul>
<p>Please note that if and when the current LTS releases (0.11 and 0.12) have new releases, they will continue to use the <code>aries_cloudagent</code> source folder, the existing locations for the <a href="https://pypi.org">PyPi</a> and <a href="https://ghcr.io">GHCR</a> container image artifacts.</p>
<h4 id="110rc0-categorized-list-of-pull-requests">1.1.0rc0 Categorized List of Pull Requests<a class="headerlink" href="#110rc0-categorized-list-of-pull-requests" title="Permanent link">&para;</a></h4>
<h4 id="110rc1-categorized-list-of-pull-requests">1.1.0rc1 Categorized List of Pull Requests<a class="headerlink" href="#110rc1-categorized-list-of-pull-requests" title="Permanent link">&para;</a></h4>
<ul>
<li>
<p>Updates related to the move and rename of the repository from the Hyperledger to <a href="https://openwallet.foundation/">OpenWallet Foundation</a> GitHub organization</p>
<ul>
<li>Change pypi upload workflow to use pypa/gh-action-pypi-publish <a href="https://github.com/openwallet-foundation/acapy/pull/3291">#3291</a> <a href="https://github.com/jamshale">jamshale</a></li>
<li>Update interop fork location after AATH update <a href="https://github.com/openwallet-foundation/acapy/pull/3282">#3282</a> <a href="https://github.com/jamshale">jamshale</a></li>
<li>Fix interop test fork location replacement <a href="https://github.com/openwallet-foundation/acapy/pull/3280">#3280</a> <a href="https://github.com/jamshale">jamshale</a></li>
<li>Update MDs and release publishing files to reflect the repo move to OWF <a href="https://github.com/openwallet-foundation/acapy/pull/3270">#3270</a> <a href="https://github.com/swcurran">swcurran</a></li>
Expand All @@ -3029,13 +3030,14 @@ <h4 id="110rc0-categorized-list-of-pull-requests">1.1.0rc0 Categorized List of P
<li>
<p>Release management pull requests:</p>
<ul>
<li>1.1.0rc1 <a href="https://github.com/openwallet-foundation/acapy/pull/3292">#3292</a> <a href="https://github.com/swcurran">swcurran</a></li>
<li>1.1.0rc0 <a href="https://github.com/openwallet-foundation/acapy/pull/3284">#3284</a> <a href="https://github.com/swcurran">swcurran</a></li>
</ul>
</li>
<li>
<p>Dependabot PRs</p>
<ul>
<li><a href="https://github.com/openwallet-foundation/acapy/pulls?q=is%3Apr+is%3Amerged+merged%3A2024-10-08..2024-10-11+author%3Aapp%2Fdependabot+">Link to list of Dependabot PRs in this release</a></li>
<li><a href="https://github.com/openwallet-foundation/acapy/pulls?q=is%3Apr+is%3Amerged+merged%3A2024-10-08..2024-10-15+author%3Aapp%2Fdependabot+">Link to list of Dependabot PRs in this release</a></li>
</ul>
</li>
</ul>
Expand Down
4 changes: 2 additions & 2 deletions main/Managing-ACA-Py-Doc-Site/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2400,7 +2400,7 @@ <h2 id="generation-process">Generation Process<a class="headerlink" href="#gener
and mkdocs configuration.</p>
<p>When the GitHub Action fires, it runs a container that carries out the following steps:</p>
<ul>
<li>Checks out the triggering branch, either <code>main</code> or <code>docs-v&lt;version&gt;</code> (e.g <code>docs-v1.1.0rc0</code>).</li>
<li>Checks out the triggering branch, either <code>main</code> or <code>docs-v&lt;version&gt;</code> (e.g <code>docs-v1.1.0rc1</code>).</li>
<li>Runs the script <a href="https://github.com/openwallet-foundation/acapy/blob/main/scripts/prepmkdocs.sh">scripts/prepmkdocs.sh</a>, which moves and updates some of the
markdown files so that they fit into the generated site. See the comments in
the scripts for details about the copying and editing done via the script. In
Expand Down Expand Up @@ -2471,7 +2471,7 @@ <h2 id="removing-rc-releases-from-the-generated-site">Removing RC Releases From
<li>Check your <code>git status</code> and make sure there are no changes in the branch --
e.g., new files that shouldn't be added to the <code>gh-pages</code> branch. If there are
any -- delete the files so they are not added.</li>
<li>Remove the folder for the RC. For example <code>rm -rf 1.1.0rc0</code></li>
<li>Remove the folder for the RC. For example <code>rm -rf 1.1.0rc1</code></li>
<li>Edit the <code>versions.json</code> file and remove the reference to the RC release in
the file.</li>
<li>Push the changes via a PR to the ACA-Py <code>gh-pages</code> branch (don't PR them into
Expand Down
4 changes: 2 additions & 2 deletions main/PUBLISHING/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2282,7 +2282,7 @@ <h1 id="how-to-publish-a-new-version">How to Publish a New Version<a class="head
<p>Once ready to do a release, create a local branch that includes the following updates:</p>
<ol>
<li>
<p>Create a local PR branch from an updated <code>main</code> branch, e.g. "1.1.0rc0".</p>
<p>Create a local PR branch from an updated <code>main</code> branch, e.g. "1.1.0rc1".</p>
</li>
<li>
<p>See if there are any Document Site <code>mkdocs</code> changes needed. Run the script
Expand Down Expand Up @@ -2411,7 +2411,7 @@ <h1 id="how-to-publish-a-new-version">How to Publish a New Version<a class="head
<ol>
<li>
<p>When a new release is tagged, create a new branch at the same commit with
the branch name in the format <code>docs-v&lt;version&gt;</code>, for example, <code>docs-v1.1.0rc0</code>.
the branch name in the format <code>docs-v&lt;version&gt;</code>, for example, <code>docs-v1.1.0rc1</code>.
The creation of the branch triggers the execution of the <a href="https://github.com/openwallet-foundation/acapy/blob/main/.github/workflows/publish-docs.yml">publish-docs</a>
GitHub Action which generates the documentation for the new release,
publishing it at <a href="https://aca-py.org">https://aca-py.org</a>. The GitHub Action also executes when
Expand Down
2 changes: 1 addition & 1 deletion main/search/search_index.json

Large diffs are not rendered by default.

0 comments on commit e4f85f3

Please sign in to comment.