Merge pull request #3284 from swcurran/1.1.0rc0

1.1.0rc0

CHANGELOG.md

@@ -1,5 +1,56 @@
 # Aries Cloud Agent Python Changelog
 
+## 1.1.0rc0
+
+### October 11, 2024
+
+Release 1.1.0 is the first release of ACA-Py from the [OpenWallet Foundation] (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 ([https://github.com/openwallet-foundation/acapy](https://github.com/openwallet-foundation/acapy)). Almost all of the changes in the release are related to the move.
+
+[OpenWallet Foundation]: https://openwallet.foundation/
+
+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 `aries_cloudagent` to `acapy_agent`). See the [Release 1.1.0 breaking changes](#110rc0-breaking-changes) for the details.
+
+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 [GitHub Issue #3250]. We'll keep you informed about the approach, timeline, and progress of the move. Stay tuned!
+
+[GitHub Issue #3250]: https://github.com/hyperledger/aries-cloudagent-python/issues/3250
+
+### 1.1.0rc0 Deprecation Notices
+
+The same **[deprecation notices](#101-deprecation-notices)** from the [1.0.1](#101) 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!
+
+### 1.1.0rc0 Breaking Changes
+
+The only (but significant) breaking changes in 1.1.0 are related to the GitHub organization and project name changes. Specific impacts are:
+
+- the renaming of the source code folder from `aries_cloudagent` to `acapy_agent`,
+- the publication of the [PyPi] project under the new `acapy_agent` name, and
+- the use of the OWF organizational GitHub Container Registry ([GHCR]) and `acapy_agent` as the name for release container image artifacts.
+  - The patterns for the image tags remain the same as before. So, for example, the new nightly artifact can be found here: [docker pull ghcr.io/openwallet-foundation/acapy-agent:py3.12-nightly](docker pull ghcr.io/openwallet-foundation/acapy-agent:py3.12-nightly).
+
+[PyPi]: https://pypi.org
+[GHCR]: https://ghcr.io
+
+Anyone deploying ACA-Py should use this release to update their existing deployments. Since there are no other changes to ACA-Py, any issues found should relate back to those changes.
+
+- Deployments referencing the [PyPi] project (including those in custom plugins) **MUST** update their deployments to use the new name.
+- Deployments sourcing the ACA-Py published container image artifacts to [GHCR] must update their deployments to use the new URLs.
+
+Please note that if and when the current LTS releases (0.11 and 0.12) have new releases, they will continue to use the `aries_cloudagent` source folder, the existing locations for the [PyPi] and [GHCR] container image artifacts.
+
+#### 1.1.0rc0 Categorized List of Pull Requests
+
+- Updates related to the move and rename of the repository from the Hyperledger to [OpenWallet Foundation] GitHub organization
+  - Update interop fork location after AATH update [\#3282](https://github.com/openwallet-foundation/acapy/pull/3282) [jamshale](https://github.com/jamshale)
+  - Fix interop test fork location replacement [\#3280](https://github.com/openwallet-foundation/acapy/pull/3280) [jamshale](https://github.com/jamshale)
+  - Update MDs and release publishing files to reflect the repo move to OWF [\#3270](https://github.com/openwallet-foundation/acapy/pull/3270) [swcurran](https://github.com/swcurran)
+  - General repo updates post OWF move. [\#3267](https://github.com/openwallet-foundation/acapy/pull/3267) [jamshale](https://github.com/jamshale)
+
+- Release management pull requests:
+  - 1.1.0rc0 [\#3284](https://github.com/openwallet-foundation/acapy/pull/3284) [swcurran](https://github.com/swcurran)
+
+- Dependabot PRs
+  - [Link to list of Dependabot PRs in this release](https://github.com/openwallet-foundation/acapy/pulls?q=is%3Apr+is%3Amerged+merged%3A2024-10-08..2024-10-11+author%3Aapp%2Fdependabot+)
+
 ## 1.0.1
 
 ### October 8, 2024
@@ -17,11 +68,11 @@ The 1.0.1 release contains mostly internal clean ups, technical debt elimination
 [Aries Agent Test Harness]: https://github.com/hyperledger/aries-agent-test-harness
 [VC-DI]: https://www.w3.org/TR/vc-data-integrity/
 
-There are several important **[deprecation notices](#deprecation-notices)** in this release in preparation for the next ACA-Py release. Please review these notifications carefully!
+There are several important **[deprecation notices](#101-deprecation-notices)** in this release in preparation for the next ACA-Py release. Please review these notifications carefully!
 
 In an attempt to shorten the categorized list of PRs in the release, rather than listing all of the `dependabot` PRs in the release, we've included a link to a list of those PRs.
 
-#### Deprecation Notices
+#### 1.0.1 Deprecation Notices
 
 - ACA-Py will soon be moved from the Hyperledger GitHub organization to that of the [OpenWallet Foundation]. As such, there will be changes in the names and locations of the artifacts produced -- the [PyPi] project and the container images in the [GitHub Container Registry]. We will retain the ability to publish LTS releases of ACA-Py for the current LTS versions (0.11, 0.12) in the current locations. For details, guidance, timing, and progress on the move, please monitor the description of [GitHub Issue #3250] that will be maintained throughout the process.
 
@@ -190,7 +241,7 @@ With the focus of the pull requests for this release on stabilizing the implemen
   - Fix typo credetial, uste [\#3146](https://github.com/hyperledger/aries-cloudagent-python/pull/3146) [rngadam](https://github.com/rngadam)
   - Fix links to AliceGetsAPhone.md from abs to rel and blob refs [\#3128](https://github.com/hyperledger/aries-cloudagent-python/pull/3128) [rngadam](https://github.com/rngadam)
   - DOC: Verifiable Credential Data Integrity (VC-DI) Credentials in Aries Cloud Agent Python (ACA-Py) #2947 [\#3110](https://github.com/hyperledger/aries-cloudagent-python/pull/3110) [kenechukwu-orjiene](https://github.com/kenechukwu-orjiene)
-  - demo/Aries-Workshop.md tweak for Traction Sandbox update [\#3136](https://github.com/hyperledger/aries-cloudagent-python/pull/3136) [loneil](https://github.com/loneil)
+  - demo/ACA-Py-Workshop.md tweak for Traction Sandbox update [\#3136](https://github.com/hyperledger/aries-cloudagent-python/pull/3136) [loneil](https://github.com/loneil)
   - Adds documentation site docs for releases 0.11.0 [\#3133](https://github.com/hyperledger/aries-cloudagent-python/pull/3133) [swcurran](https://github.com/swcurran)
   - Add descriptive error for issuance without RevRegRecord [\#3109](https://github.com/hyperledger/aries-cloudagent-python/pull/3109) [jamshale](https://github.com/jamshale)
   - Switch from black to ruff [\#3080](https://github.com/hyperledger/aries-cloudagent-python/pull/3080) [jamshale](https://github.com/jamshale)

Managing-ACA-Py-Doc-Site.md

@@ -20,7 +20,7 @@ and mkdocs configuration.
 
 When the GitHub Action fires, it runs a container that carries out the following steps:
 
-- Checks out the triggering branch, either `main` or `docs-v<version>` (e.g `docs-v1.0.1`).
+- Checks out the triggering branch, either `main` or `docs-v<version>` (e.g `docs-v1.1.0rc0`).
 - Runs the script [scripts/prepmkdocs.sh], 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
@@ -97,7 +97,7 @@ To delete the documentation version, do the following:
 - Check your `git status` and make sure there are no changes in the branch --
   e.g., new files that shouldn't be added to the `gh-pages` branch. If there are
   any -- delete the files so they are not added.
-- Remove the folder for the RC.  For example `rm -rf 1.0.1rc1`
+- Remove the folder for the RC.  For example `rm -rf 1.1.0rc0`
 - Edit the `versions.json` file and remove the reference to the RC release in
   the file.
 - Push the changes via a PR to the ACA-Py `gh-pages` branch (don't PR them into

PUBLISHING.md

@@ -6,7 +6,7 @@ a major, minor or patch release, per [semver](https://semver.org/) rules.
 
 Once ready to do a release, create a local branch that includes the following updates:
 
-1. Create a local PR branch from an updated `main` branch, e.g. "1.0.1".
+1. Create a local PR branch from an updated `main` branch, e.g. "1.1.0rc0".
 
 2. See if there are any Document Site `mkdocs` changes needed. Run the script
    `./scripts/prepmkdocs.sh; mkdocs`. Watch the log, noting particularly if
@@ -68,14 +68,15 @@ Once you have the list of PRs:
 - Organize the list into suitable categories in the [CHANGELOG.md](CHANGELOG.md) file, update (if necessary) the PR title and add notes to clarify the changes. See previous release entries to understand the style -- a format that should help developers.
 - Add a narrative about the release above the PR that highlights what has gone into the release.
 - To cover the `dependabot` PRs without listing them all, add to the end of the
-  categorized list of PRs the last two lines of the script output. Make sure the dates are right! The text will look like this:
+  categorized list of PRs the two `dependabot` lines of the script output (after the list of PRs). The text will look like this:
 
 ```text
 - Dependabot PRs
   - [List of Dependabot PRs in this release](https://github.com/openwallet-foundation/acapy/pulls?q=is%3Apr+is%3Amerged+merged%3A2024-08-16..2024-09-16+author%3Aapp%2Fdependabot+)
 ```
 
-Include a PR for this soon-to-be PR. You can guess at the number of the PR by using this command `gh issue list -s all -L 2; gh pr ls -s all -L 2` to see the highest PR and issues, but you still might have to correct the number after you create the PR if someone sneaks one in before you submit your PR.
+- Check the dates in the `dependabot` URL to make sure the full period between the previous non-RC release to the date of the non-RC release you are preparing.
+- Include a PR in the list for this soon-to-be PR, initially with the "next to be issued" number for PRs/Issues. At the end output of the script is the highest numbered PR and issue. Your PR will be one higher than the highest of those two numbers. Note that you still might have to correct the number after you create the PR if someone sneaks an issue or PR in before you submit your PR.
 
 5. Check to see if there are any other PRs that should be included in the release.
 
@@ -101,9 +102,9 @@ Include a PR for this soon-to-be PR. You can guess at the number of the PR by us
    to better follow the semver rules.
 
 8. Regenerate openapi.json and swagger.json by running
-   `scripts/generate-open-api-spec` from within the `aries_cloudagent` folder.
+   `scripts/generate-open-api-spec` from within the `acapy_agent` folder.
 
-   Command: `cd aries_cloudagent;../scripts/generate-open-api-spec;cd ..`
+   Command: `cd acapy_agent;../scripts/generate-open-api-spec;cd ..`
 
    Folders may not be cleaned up by the script, so the following can be run, likely with `sudo` -- `rm -rf open-api/.build`. The folder is `.gitignore`d, so there is not a danger they will be pushed, even if they are not deleted.
 
@@ -139,7 +140,7 @@ Include a PR for this soon-to-be PR. You can guess at the number of the PR by us
 [publish-indy.yml]: https://github.com/openwallet-foundation/acapy/blob/main/.github/workflows/publish-indy.yml
 
 1.   When a new release is tagged, create a new branch at the same commit with
-    the branch name in the format `docs-v<version>`, for example, `docs-v1.0.1rc1`.
+    the branch name in the format `docs-v<version>`, for example, `docs-v1.1.0rc0`.
     The creation of the branch triggers the execution of the [publish-docs]
     GitHub Action which generates the documentation for the new release,
     publishing it at [https://aca-py.org]. The GitHub Action also executes when

README.md

@@ -126,7 +126,7 @@ Use the ["install and go" page for developers](./docs/features/DevReadMe.md) if
 
 If you would like to develop on ACA-Py locally note that we use Poetry for dependency management and packaging. If you are unfamiliar with poetry please see our [cheat sheet](./docs/deploying/Poetry.md)
 
-[Traction Workshop]: ./docs/demo/Aries-Workshop.md
+[Traction Workshop]: ./docs/demo/ACA-Py-Workshop.md
 
 ## About the ACA-Py Admin API
 

docs/demo/ACA-Py-Workshop.md

@@ -243,7 +243,7 @@ The ACA-Py/Traction API is pretty large, but it is reasonably well organized, an
 
 We’re still working on a good demo for the OpenAPI from Traction, but [this one
 from
-ACA-Py](https://aca-py.org/main/demo/AriesOpenAPIDemo/#using-the-openapiswagger-user-interface)
+ACA-Py](https://aca-py.org/main/demo/OpenAPIDemo/#using-the-openapiswagger-user-interface)
 is a good outline of the process. It doesn't use your Traction Tenant, but you
 should get the idea about the sequence of calls to make to accomplish Aries-type
 activities. For example, see if you can carry out the steps to do the [Lab

docs/demo/AliceGetsAPhone.md

@@ -168,7 +168,7 @@ Use the ngrok url for the tails server that you noted earlier.
 
 #### Waiting for the Faber agent to start ...
 
-The `Preparing agent image...` step on the first run takes a bit of time, so while we wait, let's look at the details of the commands. Running Faber is similar to the instructions in the [Aries OpenAPI Demo](./AriesOpenAPIDemo.md) "Play with Docker" section, except:
+The `Preparing agent image...` step on the first run takes a bit of time, so while we wait, let's look at the details of the commands. Running Faber is similar to the instructions in the [Aries OpenAPI Demo](./OpenAPIDemo.md) "Play with Docker" section, except:
 
 - We are using the BCovrin Test network because that is a network that the mobile agents can be configured to use.
 - We are running in "auto" mode, so we will make no manual acknowledgements.

docs/generated/acapy_agent.admin.rst

@@ -0,0 +1,50 @@
+acapy\_agent.admin package
+==========================
+
+.. automodule:: acapy_agent.admin
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+acapy\_agent.admin.base\_server module
+--------------------------------------
+
+.. automodule:: acapy_agent.admin.base_server
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+acapy\_agent.admin.error module
+-------------------------------
+
+.. automodule:: acapy_agent.admin.error
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+acapy\_agent.admin.request\_context module
+------------------------------------------
+
+.. automodule:: acapy_agent.admin.request_context
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+acapy\_agent.admin.routes module
+--------------------------------
+
+.. automodule:: acapy_agent.admin.routes
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+acapy\_agent.admin.server module
+--------------------------------
+
+.. automodule:: acapy_agent.admin.server
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/generated/acapy_agent.anoncreds.default.did_indy.rst

@@ -0,0 +1,26 @@
+acapy\_agent.anoncreds.default.did\_indy package
+================================================
+
+.. automodule:: acapy_agent.anoncreds.default.did_indy
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+acapy\_agent.anoncreds.default.did\_indy.registry module
+--------------------------------------------------------
+
+.. automodule:: acapy_agent.anoncreds.default.did_indy.registry
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+acapy\_agent.anoncreds.default.did\_indy.routes module
+------------------------------------------------------
+
+.. automodule:: acapy_agent.anoncreds.default.did_indy.routes
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/generated/acapy_agent.anoncreds.default.did_web.rst

@@ -0,0 +1,26 @@
+acapy\_agent.anoncreds.default.did\_web package
+===============================================
+
+.. automodule:: acapy_agent.anoncreds.default.did_web
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+acapy\_agent.anoncreds.default.did\_web.registry module
+-------------------------------------------------------
+
+.. automodule:: acapy_agent.anoncreds.default.did_web.registry
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+acapy\_agent.anoncreds.default.did\_web.routes module
+-----------------------------------------------------
+
+.. automodule:: acapy_agent.anoncreds.default.did_web.routes
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/generated/acapy_agent.anoncreds.default.legacy_indy.rst

@@ -0,0 +1,42 @@
+acapy\_agent.anoncreds.default.legacy\_indy package
+===================================================
+
+.. automodule:: acapy_agent.anoncreds.default.legacy_indy
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+acapy\_agent.anoncreds.default.legacy\_indy.author module
+---------------------------------------------------------
+
+.. automodule:: acapy_agent.anoncreds.default.legacy_indy.author
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+acapy\_agent.anoncreds.default.legacy\_indy.recover module
+----------------------------------------------------------
+
+.. automodule:: acapy_agent.anoncreds.default.legacy_indy.recover
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+acapy\_agent.anoncreds.default.legacy\_indy.registry module
+-----------------------------------------------------------
+
+.. automodule:: acapy_agent.anoncreds.default.legacy_indy.registry
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+acapy\_agent.anoncreds.default.legacy\_indy.routes module
+---------------------------------------------------------
+
+.. automodule:: acapy_agent.anoncreds.default.legacy_indy.routes
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/generated/acapy_agent.anoncreds.default.rst

@@ -0,0 +1,17 @@
+acapy\_agent.anoncreds.default package
+======================================
+
+.. automodule:: acapy_agent.anoncreds.default
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   acapy_agent.anoncreds.default.did_indy
+   acapy_agent.anoncreds.default.did_web
+   acapy_agent.anoncreds.default.legacy_indy

docs/generated/acapy_agent.anoncreds.models.rst

@@ -0,0 +1,34 @@
+acapy\_agent.anoncreds.models package
+=====================================
+
+.. automodule:: acapy_agent.anoncreds.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+acapy\_agent.anoncreds.models.anoncreds\_cred\_def module
+---------------------------------------------------------
+
+.. automodule:: acapy_agent.anoncreds.models.anoncreds_cred_def
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+acapy\_agent.anoncreds.models.anoncreds\_revocation module
+----------------------------------------------------------
+
+.. automodule:: acapy_agent.anoncreds.models.anoncreds_revocation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+acapy\_agent.anoncreds.models.anoncreds\_schema module
+------------------------------------------------------
+
+.. automodule:: acapy_agent.anoncreds.models.anoncreds_schema
+   :members:
+   :undoc-members:
+   :show-inheritance: