Skip to content

Commit aa3a343

Browse files
authored
* 1.2.1rc0 Signed-off-by: Stephen Curran <[email protected]> * Add warning to 1.2.0 Signed-off-by: Stephen Curran <[email protected]> * Improve format of warning Signed-off-by: Stephen Curran <[email protected]> --------- Signed-off-by: Stephen Curran <[email protected]>
1 parent 537f8d3 commit aa3a343

13 files changed

+115
-42
lines changed

CHANGELOG.md

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,62 @@
11
# Aries Cloud Agent Python Changelog
22

3+
## 1.2.1rc0
4+
5+
### January 21, 2025
6+
7+
Release 1.2.1 is a patch to fix a couple of issues introduced in [Release 1.2.0](#120) that prevent the startup of multi-tenant/single database instances of ACA-Py. The release includes the fixes, plus a new test for testing ACA-Py upgrades -- a new test type introduced in [Release 1.2.0](#120). Given that there are no breaking changes in this release, we'll move the [1.2.lts branch](https://github.com/openwallet-foundation/acapy/tree/1.2.lts) to be based on this release.
8+
9+
Enhancements in Release 1.2.1 are the addition of support for the Linked Data proof cryptosuite `EcdsaSecp256r1Signature2019`, and support for P256 keys generally and in `did:key` form.
10+
11+
### 1.2.1rc0 Deprecation Notices
12+
13+
The same **[deprecation notices](#101-deprecation-notices)** from the [1.1.0](#110) release about AIP 1.0 protocols still apply. The protocols remain in the 1.2.1 release, but will be moved out of the core and into plugins soon. Please review these notifications carefully!
14+
15+
### 1.2.1rc0 Breaking Changes
16+
17+
There are no breaking changes in this release, just fixes, new tests and minor updates.
18+
19+
#### 1.2.1rc0 Categorized List of Pull Requests
20+
21+
- Linked Data Proof and Key Type Additions
22+
- Support EcdsaSecp256r1Signature2019 linked data proof [\#3443](https://github.com/openwallet-foundation/acapy/pull/3443) [gmulhearn](https://github.com/gmulhearn)
23+
- Support P256 keys & did:keys [\#3442](https://github.com/openwallet-foundation/acapy/pull/3442) [gmulhearn](https://github.com/gmulhearn)
24+
25+
- Startup, Wallet Keys, and Upgrade Fixes
26+
- Check admin wallet anoncreds upgrade on startup [\#3458](https://github.com/openwallet-foundation/acapy/pull/3458) [jamshale](https://github.com/jamshale)
27+
- Add Multi-tenancy single wallet upgrade test [\#3457](https://github.com/openwallet-foundation/acapy/pull/3457) [jamshale](https://github.com/jamshale)
28+
- Pass the correct key for multitenant single wallets [\#3450](https://github.com/openwallet-foundation/acapy/pull/3450) [jamshale](https://github.com/jamshale)
29+
- Prevent dummy profiles on start up [\#3449](https://github.com/openwallet-foundation/acapy/pull/3449) [jamshale](https://github.com/jamshale)
30+
- Fixed handling of base wallet routes in auth decorator [\#3448](https://github.com/openwallet-foundation/acapy/pull/3448) [esune](https://github.com/esune)
31+
32+
- DID Registration and Resolution
33+
- Change did:tdw resolver naming to did:webvh [\#3429](https://github.com/openwallet-foundation/acapy/pull/3429) [jamshale](https://github.com/jamshale)
34+
35+
- Test Suite Updates and Artifact Publishing
36+
- Only copy agent code in dockerfiles [\#3393](https://github.com/openwallet-foundation/acapy/pull/3393) [jamshale](https://github.com/jamshale)
37+
38+
- Internal Improvements / Cleanups / Tech Debt Updates
39+
- Update versions.json to correct the version drop down on aca-py.org [\#3434](https://github.com/openwallet-foundation/acapy/pull/3434) [swcurran](https://github.com/swcurran)
40+
- Follow up from Release 1.2.0 -- including LTS change [\#3432](https://github.com/openwallet-foundation/acapy/pull/3432) [swcurran](https://github.com/swcurran)
41+
42+
- Consolidate Dependabot updates and other library/dependency updates
43+
- :arrow_up: Upgrade dev dependencies [\#3454](https://github.com/openwallet-foundation/acapy/pull/3454) [ff137](https://github.com/ff137)
44+
- :recycle: Sync ruff version in workflows [\#3447](https://github.com/openwallet-foundation/acapy/pull/3447) [ff137](https://github.com/ff137)
45+
46+
- Release management pull requests:
47+
- 1.2.1rc0 [\#3459](https://github.com/openwallet-foundation/acapy/pull/3459) [swcurran](https://github.com/swcurran)
48+
49+
- Dependabot PRs
50+
- [Link to list of Dependabot PRs in this release](https://github.com/openwallet-foundation/acapy/pulls?q=is%3Apr+is%3Amerged+merged%3A2025-01-08..2025-01-21+author%3Aapp%2Fdependabot+)
51+
352
## 1.2.0
453

554
### January 8, 2025
655

56+
!!! warning "Multi-tenant, Single Database Deployments"
57+
58+
A bug in Release 1.2.0 prevents using the release with existing multi-tenant, single wallet deployments. Those requiring such support **must** skip Release 1.2.0 and move to Release 1.2.1rc0 or higher.
59+
760
Release 1.2.0 is a minor update to ACA-Py that contains an update to the AnonCreds implementation to make it easier to deploy on other than Hyperledger Indy, and a lengthy list of adjustments, improvements and fixes, with a focus on removing technical debt. In addition to the AnonCreds updates, the most visible change is the removal of the "in-memory wallet" implementation in favour of using the SQLite in-memory wallet (`sqlite://:memory:`), including removing the logic for handling that extra wallet type. In removing the in-memory wallet, all of the unit and integration tests that used the in-memory wallet have been updated to use SQLite's in-memory wallet.
861

962
Release 1.2.x is the new current Long Term Support (LTS) for ACA-Py, as defined in the [LTS Strategy](./LTS-Strategy.md) document. With this release, the "end of life" for the previous "current LTS release" -- [0.12](#0123) -- is set for October 2025.
@@ -154,7 +207,7 @@ The only (but significant) breaking changes in 1.1.0 are related to the GitHub o
154207
- the renaming of the source code folder from `aries_cloudagent` to `acapy_agent`,
155208
- the publication of the [PyPi] project under the new `acapy_agent` name, and
156209
- the use of the OWF organizational GitHub Container Registry ([GHCR]) and `acapy_agent` as the name for release container image artifacts.
157-
- 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).
210+
- 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`.
158211

159212
[PyPi]: https://pypi.org
160213
[GHCR]: https://ghcr.io

Managing-ACA-Py-Doc-Site.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ and mkdocs configuration.
2020

2121
When the GitHub Action fires, it runs a container that carries out the following steps:
2222

23-
- Checks out the triggering branch, either `main` or `docs-v<version>` (e.g `docs-v1.2.0`).
23+
- Checks out the triggering branch, either `main` or `docs-v<version>` (e.g `docs-v1.2.1rc0`).
2424
- Runs the script [scripts/prepmkdocs.sh], which moves and updates some of the
2525
markdown files so that they fit into the generated site. See the comments in
2626
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:
9797
- Check your `git status` and make sure there are no changes in the branch --
9898
e.g., new files that shouldn't be added to the `gh-pages` branch. If there are
9999
any -- delete the files so they are not added.
100-
- Remove the folder for the RC. For example `rm -rf 1.2.0`
100+
- Remove the folder for the RC. For example `rm -rf 1.2.1rc0`
101101
- Edit the `versions.json` file and remove the reference to the RC release in
102102
the file.
103103
- Push the changes via a PR to the ACA-Py `gh-pages` branch (don't PR them into

PUBLISHING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ a major, minor or patch release, per [semver](https://semver.org/) rules.
66

77
Once ready to do a release, create a local branch that includes the following updates:
88

9-
1. Create a local PR branch from an updated `main` branch, e.g. "1.2.0".
9+
1. Create a local PR branch from an updated `main` branch, e.g. "1.2.1rc0".
1010

1111
2. See if there are any Document Site `mkdocs` changes needed. Run the script
1212
`./scripts/prepmkdocs.sh; mkdocs`. Watch the log, noting particularly if
@@ -78,17 +78,17 @@ Once you have the list of PRs:
7878
- 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.
7979
- 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.
8080

81-
1. Check to see if there are any other PRs that should be included in the release.
81+
5. Check to see if there are any other PRs that should be included in the release.
8282

83-
2. Update the ReadTheDocs in the `/docs` folder by following the instructions in
83+
6. Update the ReadTheDocs in the `/docs` folder by following the instructions in
8484
the `docs/UpdateRTD.md` file. That will likely add a number of new and modified
8585
files to the PR. Eliminate all of the errors in the generation process,
8686
either by mocking external dependencies or by fixing ACA-Py code. If
8787
necessary, create an issue with the errors and assign it to the appropriate
8888
developer. Experience has demonstrated to use that documentation generation
8989
errors should be fixed in the code.
9090

91-
3. Search across the repository for the previous version number and update it
91+
7. Search across the repository for the previous version number and update it
9292
everywhere that makes sense. The CHANGELOG.md entry for the previous release
9393
is a likely exception, and the `pyproject.toml` in the root **MUST** be
9494
updated. You can skip (although it won't hurt) to update the files in the
@@ -101,28 +101,28 @@ Once you have the list of PRs:
101101
have dropped the previously used `-` in the release candidate version string
102102
to better follow the semver rules.
103103

104-
4. Regenerate openapi.json and swagger.json by running
104+
8. Regenerate openapi.json and swagger.json by running
105105
`scripts/generate-open-api-spec` from within the `acapy_agent` folder.
106106

107107
Command: `cd acapy_agent;../scripts/generate-open-api-spec;cd ..`
108108

109109
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.
110110

111-
5. Double check all of these steps above, and then submit a PR from the branch.
111+
9. Double check all of these steps above, and then submit a PR from the branch.
112112
Add this new PR to CHANGELOG.md so that all the PRs are included.
113113
If there are still further changes to be merged, mark the PR as "Draft",
114114
repeat **ALL** of the steps again, and then mark this PR as ready and then
115115
wait until it is merged. It's embarrassing when you have to do a whole new
116116
release just because you missed something silly...I know!
117117

118-
6. Immediately after it is merged, create a new GitHub tag representing the
118+
10. Immediately after it is merged, create a new GitHub tag representing the
119119
version. The tag name and title of the release should be the same as the
120120
version in [pyproject.toml](https://github.com/openwallet-foundation/acapy/tree/main/pyproject.toml). Use
121121
the "Generate Release Notes" capability to get a sequential listing of the
122122
PRs in the release, to complement the manually curated Changelog. Verify on
123123
PyPi that the version is published.
124124

125-
7. New images for the release are automatically published by the GitHubAction
125+
11. New images for the release are automatically published by the GitHubAction
126126
Workflows: [publish.yml] and [publish-indy.yml]. The actions are triggered
127127
when a release is tagged, so no manual action is needed. The images are
128128
published in the [OpenWallet Foundation Package Repository under
@@ -139,8 +139,8 @@ Once you have the list of PRs:
139139
[publish.yml]: https://github.com/openwallet-foundation/acapy/blob/main/.github/workflows/publish.yml
140140
[publish-indy.yml]: https://github.com/openwallet-foundation/acapy/blob/main/.github/workflows/publish-indy.yml
141141

142-
1. When a new release is tagged, create a new branch at the same commit with
143-
the branch name in the format `docs-v<version>`, for example, `docs-v1.2.0`.
142+
12. When a new release is tagged, create a new branch at the same commit with
143+
the branch name in the format `docs-v<version>`, for example, `docs-v1.2.1rc0`.
144144
The creation of the branch triggers the execution of the [publish-docs]
145145
GitHub Action which generates the documentation for the new release,
146146
publishing it at [https://aca-py.org]. The GitHub Action also executes when

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ the [LTS strategy](./LTS-Strategy.md).
5353

5454
Current LTS releases:
5555

56-
- Release [1.2](https://github.com/openwallet-foundation/acapy/releases/tag/1.2.0) **Current LTS Release**
56+
- Release [1.2](https://github.com/openwallet-foundation/acapy/releases/tag/1.2.1rc0) **Current LTS Release**
5757
- Release [0.12](https://github.com/openwallet-foundation/acapy/releases/tag/0.12.3) **End of Life: October 2025**
5858

5959
Past LTS releases:

docs/UpdateRTD.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ cd docs; sphinx-build -b html -a -E -c ./ ./ ./_build; cd ..
3535
Once generated, go into the `docs/_build` folder and open `index.html` in a browser. Note that the `_build` is
3636
`.gitignore`'d and so will not be part of a git push.
3737

38+
If the script does not run at all, you may need to do a `pip install -r
39+
docs/requirements.txt` to update the Sphinx dependencies.
40+
3841
### Look for Errors
3942

4043
This is the hard part; looking for errors in docstrings added by devs. Some tips:

docs/features/SupportedRFCs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ACA-Py or the repository `main` branch. Reminders (and PRs!) to update this page
88
welcome! If you have any questions, please contact us on the #aries channel on
99
[OpenWallet Foundation Discord](https://discord.gg/openwallet-foundation) or through an issue in this repo.
1010

11-
**Last Update**: 2025-01-07, Release 1.2.0
11+
**Last Update**: 2025-01-21, Release 1.2.1rc0
1212

1313
> The checklist version of this document was created as a joint effort
1414
> between [Northern Block](https://northernblock.io/), [Animo Solutions](https://animo.id/) and the Ontario government, on behalf of the Ontario government.
@@ -56,7 +56,7 @@ A summary of the Aries Interop Profiles and Aries RFCs supported in ACA-Py can b
5656
| Credential Type | Supported | Notes |
5757
| --- | :--: | -- |
5858
| [Hyperledger AnonCreds] | :white_check_mark: | Includes full issue VC, present proof, and revoke VC support. |
59-
| [W3C Verifiable Credentials Data Model](https://www.w3.org/TR/vc-data-model/) | :white_check_mark: | Supports JSON-LD Data Integrity Proof Credentials using the `Ed25519Signature2018`, `BbsBlsSignature2020` and `BbsBlsSignatureProof2020` signature suites.<br><br>Supports the [DIF Presentation Exchange](https://identity.foundation/presentation-exchange/) data format for presentation requests and presentation submissions.<br><br>Work currently underway to add support for [Hyperledger AnonCreds] in W3C VC JSON-LD Format |
59+
| [W3C Verifiable Credentials Data Model](https://www.w3.org/TR/vc-data-model/) | :white_check_mark: | Supports JSON-LD Data Integrity Proof Credentials using the `Ed25519Signature2018`, `EcdsaSecp256r1Signature2019`, `BbsBlsSignature2020` and `BbsBlsSignatureProof2020` signature suites.<br><br>Supports the [DIF Presentation Exchange](https://identity.foundation/presentation-exchange/) data format for presentation requests and presentation submissions.<br><br>Work currently underway to add support for [Hyperledger AnonCreds] in W3C VC JSON-LD Format |
6060

6161
[Hyperledger AnonCreds]: https://www.hyperledger.org/projects/anoncreds
6262

docs/generated/acapy_agent.anoncreds.models.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,14 @@ acapy\_agent.anoncreds.models.schema module
105105
:undoc-members:
106106
:show-inheritance:
107107

108+
acapy\_agent.anoncreds.models.schema\_info module
109+
-------------------------------------------------
110+
111+
.. automodule:: acapy_agent.anoncreds.models.schema_info
112+
:members:
113+
:undoc-members:
114+
:show-inheritance:
115+
108116
acapy\_agent.anoncreds.models.utils module
109117
------------------------------------------
110118

docs/generated/acapy_agent.resolver.default.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,6 @@ acapy\_agent.resolver.default.peer4 module
7373
:undoc-members:
7474
:show-inheritance:
7575

76-
acapy\_agent.resolver.default.tdw module
77-
----------------------------------------
78-
79-
.. automodule:: acapy_agent.resolver.default.tdw
80-
:members:
81-
:undoc-members:
82-
:show-inheritance:
83-
8476
acapy\_agent.resolver.default.universal module
8577
----------------------------------------------
8678

@@ -96,3 +88,11 @@ acapy\_agent.resolver.default.web module
9688
:members:
9789
:undoc-members:
9890
:show-inheritance:
91+
92+
acapy\_agent.resolver.default.webvh module
93+
------------------------------------------
94+
95+
.. automodule:: acapy_agent.resolver.default.webvh
96+
:members:
97+
:undoc-members:
98+
:show-inheritance:

docs/generated/acapy_agent.vc.ld_proofs.suites.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,14 @@ acapy\_agent.vc.ld\_proofs.suites.bbs\_bls\_signature\_proof\_2020 module
3333
:undoc-members:
3434
:show-inheritance:
3535

36+
acapy\_agent.vc.ld\_proofs.suites.ecdsa\_secp256r1\_signature\_2019 module
37+
--------------------------------------------------------------------------
38+
39+
.. automodule:: acapy_agent.vc.ld_proofs.suites.ecdsa_secp256r1_signature_2019
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
43+
3644
acapy\_agent.vc.ld\_proofs.suites.ed25519\_signature\_2018 module
3745
-----------------------------------------------------------------
3846

docs/requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Defining the exact versions for ReadTheDocs that will make sure things don't break
22
sphinx==5.3.0
33
sphinx_rtd_theme==1.3.0
4-
readthedocs-sphinx-search==0.3.2
4+
readthedocs-sphinx-search==0.3.2
5+
sphinx-notfound-page==1.0.2

0 commit comments

Comments
 (0)