You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+54-1Lines changed: 54 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,62 @@
1
1
# Aries Cloud Agent Python Changelog
2
2
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)
- 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)
-[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
+
3
52
## 1.2.0
4
53
5
54
### January 8, 2025
6
55
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
+
7
60
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.
8
61
9
62
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
154
207
- the renaming of the source code folder from `aries_cloudagent` to `acapy_agent`,
155
208
- the publication of the [PyPi] project under the new `acapy_agent` name, and
156
209
- 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`.
Copy file name to clipboardExpand all lines: PUBLISHING.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ a major, minor or patch release, per [semver](https://semver.org/) rules.
6
6
7
7
Once ready to do a release, create a local branch that includes the following updates:
8
8
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".
10
10
11
11
2. See if there are any Document Site `mkdocs` changes needed. Run the script
12
12
`./scripts/prepmkdocs.sh; mkdocs`. Watch the log, noting particularly if
@@ -78,17 +78,17 @@ Once you have the list of PRs:
78
78
- 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.
79
79
- 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.
80
80
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.
82
82
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
84
84
the `docs/UpdateRTD.md` file. That will likely add a number of new and modified
85
85
files to the PR. Eliminate all of the errors in the generation process,
86
86
either by mocking external dependencies or by fixing ACA-Py code. If
87
87
necessary, create an issue with the errors and assign it to the appropriate
88
88
developer. Experience has demonstrated to use that documentation generation
89
89
errors should be fixed in the code.
90
90
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
92
92
everywhere that makes sense. The CHANGELOG.md entry for the previous release
93
93
is a likely exception, and the `pyproject.toml` in the root **MUST** be
94
94
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:
101
101
have dropped the previously used `-` in the release candidate version string
102
102
to better follow the semver rules.
103
103
104
-
4. Regenerate openapi.json and swagger.json by running
104
+
8. Regenerate openapi.json and swagger.json by running
105
105
`scripts/generate-open-api-spec` from within the `acapy_agent` folder.
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.
110
110
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.
112
112
Add this new PR to CHANGELOG.md so that all the PRs are included.
113
113
If there are still further changes to be merged, mark the PR as "Draft",
114
114
repeat **ALL** of the steps again, and then mark this PR as ready and then
115
115
wait until it is merged. It's embarrassing when you have to do a whole new
116
116
release just because you missed something silly...I know!
117
117
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
119
119
version. The tag name and title of the release should be the same as the
120
120
version in [pyproject.toml](https://github.com/openwallet-foundation/acapy/tree/main/pyproject.toml). Use
121
121
the "Generate Release Notes" capability to get a sequential listing of the
122
122
PRs in the release, to complement the manually curated Changelog. Verify on
123
123
PyPi that the version is published.
124
124
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
126
126
Workflows: [publish.yml] and [publish-indy.yml]. The actions are triggered
127
127
when a release is tagged, so no manual action is needed. The images are
128
128
published in the [OpenWallet Foundation Package Repository under
@@ -139,8 +139,8 @@ Once you have the list of PRs:
Copy file name to clipboardExpand all lines: docs/features/SupportedRFCs.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ ACA-Py or the repository `main` branch. Reminders (and PRs!) to update this page
8
8
welcome! If you have any questions, please contact us on the #aries channel on
9
9
[OpenWallet Foundation Discord](https://discord.gg/openwallet-foundation) or through an issue in this repo.
10
10
11
-
**Last Update**: 2025-01-07, Release 1.2.0
11
+
**Last Update**: 2025-01-21, Release 1.2.1rc0
12
12
13
13
> The checklist version of this document was created as a joint effort
14
14
> 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
56
56
| Credential Type | Supported | Notes |
57
57
| --- | :--: | -- |
58
58
|[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 |
0 commit comments