Skip to content

Commit 63943f4

Browse files
authored
Merge pull request #2613 from swcurran/0.11.0rc2
0.11.0rc2
2 parents 8a04943 + e985a55 commit 63943f4

File tree

8 files changed

+71
-26
lines changed

8 files changed

+71
-26
lines changed

CHANGELOG.md

Lines changed: 43 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Aries Cloud Agent Python Changelog
22

3-
## 0.11.0-rc1
3+
## 0.11.0rc2
44

5-
### October 30, 2023
5+
### November 17, 2023
66

7-
Release 0.11.0 is a relatively large release of new features, fixes, and internal
8-
updates. 0.11.0 is planned to be the last major update before we transition
9-
to using the [AnonCreds Rust](https://github.com/hyperledger/anoncreds-rs)
10-
in a release that is expected to bring some Admin/Controller API changes. We plan
11-
to do patches to 0.11.0 while the transition is made to the next breaking release.
12-
13-
*Release 0.11.0-rc0 failed to publish because of a reference to a dependency via its GitHub repository rather than to its published artifact.*
7+
Release 0.11.0 is a relatively large release of new features, fixes, and
8+
internal updates. 0.11.0 is planned to be the last major update before we
9+
transition to using the ledger agnostic [AnonCreds
10+
Rust](https://github.com/hyperledger/anoncreds-rs) in a release that is expected
11+
to bring some Admin/Controller API changes. We plan to do patches to the 0.11.x
12+
branch while the transition is made to the upcoming release to transition to
13+
using [Anoncreds Rust].
1414

1515
A significant addition to ACA-Py is support for signing and verifying
1616
[SD-JWT] verifiable credentials. We expect this to be the first of the changes
@@ -49,15 +49,34 @@ the newer value in sending messages. In updating this, we retained the old
4949
configuration parameters most deployments were using
5050
(`--emit-new-didcomm-prefix` and `--emit-new-didcomm-mime-type`) but updated the
5151
code to set the configuration parameters to `true` even if the parameters were
52-
not set. See [PR \#2517]
52+
not set. See [PR \#2517].
53+
54+
The JSON-LD verifiable credential handling of JSON-LD contexts has been updated
55+
to pre-load the base contexts into the repository code so they are not fetched
56+
at run time. This is a security best practice for JSON-LD, and prevents errors
57+
in production when, from time to time, the JSON-LD contexts are unavailable
58+
because of outages of the web servers where they are hosted. See [PR \#2587].
59+
60+
A Problem Report message is now sent when a request for a credential is received
61+
and there is no associated Credential Exchange Record. This may happen, for
62+
example, if an issuer decides to delete a Credential Exchange Record that has
63+
not be answered for a long time, and the holder responds after the delete. See
64+
[PR \#2577].
65+
66+
The versioning scheme for Release Candidates has been changed to drop the `-` in
67+
the version string. This means the older style of `0.11.0-rc0` has been changed
68+
to the newer style of `0.11.0rc2`.
5369

5470
[PR \#2517]: https://github.com/hyperledger/aries-cloudagent-python/pull/2517
71+
[PR \#2587]: https://github.com/hyperledger/aries-cloudagent-python/pull/2587
72+
[PR \#2577]: https://github.com/hyperledger/aries-cloudagent-python/pull/2577
5573

5674
#### 0.11.0 Categorized List of Pull Requests
5775

5876
- DIDComm Messaging Improvements/Fixes
5977
- Change arg_parse to always set --emit-new-didcomm-prefix and --emit-new-didcomm-mime-type to true [\#2517](https://github.com/hyperledger/aries-cloudagent-python/pull/2517) [swcurran](https://github.com/swcurran)
6078
- DID Handling and Connection Establishment Updates/Fixes
79+
- Goal and Goal Code in invitation URL. [\#2591](https://github.com/hyperledger/aries-cloudagent-python/pull/2591) [usingtechnology](https://github.com/usingtechnology)
6180
- refactor: use did-peer-2 instead of peerdid [\#2561](https://github.com/hyperledger/aries-cloudagent-python/pull/2561) [dbluhm](https://github.com/dbluhm)
6281
- Fix: Problem Report Before Exchange Established [\#2519](https://github.com/hyperledger/aries-cloudagent-python/pull/2519) [Ennovate-com](https://github.com/Ennovate-com)
6382
- fix: issue #2434: Change DIDExchange States to Match rfc160 [\#2461](https://github.com/hyperledger/aries-cloudagent-python/pull/2461) [anwalker293](https://github.com/anwalker293)
@@ -69,6 +88,8 @@ not set. See [PR \#2517]
6988
- fix: routing behind mediator [\#2536](https://github.com/hyperledger/aries-cloudagent-python/pull/2536) [dbluhm](https://github.com/dbluhm)
7089
- fix: mediation routing keys as did key [\#2516](https://github.com/hyperledger/aries-cloudagent-python/pull/2516) [dbluhm](https://github.com/dbluhm)
7190
- refactor: drop mediator_terms and recipient_terms [\#2515](https://github.com/hyperledger/aries-cloudagent-python/pull/2515) [dbluhm](https://github.com/dbluhm)
91+
- Fixes to Upgrades
92+
- 🐛 fix wallet_update when only extra_settings requested [\#2612](https://github.com/hyperledger/aries-cloudagent-python/pull/2612) [ff137](https://github.com/ff137)
7293
- Hyperledger Indy ledger related updates and fixes
7394
- fix: taa rough timestamp timezone from datetime [\#2554](https://github.com/hyperledger/aries-cloudagent-python/pull/2554) [dbluhm](https://github.com/dbluhm)
7495
- 🎨 clarify LedgerError message when TAA is required and not accepted [\#2545](https://github.com/hyperledger/aries-cloudagent-python/pull/2545) [ff137](https://github.com/ff137)
@@ -78,13 +99,21 @@ not set. See [PR \#2517]
7899
- OpenID4VC / SD-JWT Updates
79100
- chore: point to official sd-jwt lib release [\#2573](https://github.com/hyperledger/aries-cloudagent-python/pull/2573) [dbluhm](https://github.com/dbluhm)
80101
- Feat/sd jwt implementation [\#2487](https://github.com/hyperledger/aries-cloudagent-python/pull/2487) [cjhowland](https://github.com/cjhowland)
81-
- JSON-LD Verifiable Credential format updates
102+
- JSON-LD Verifiable Credential/Presentation updates
103+
- Fix Issue #2589 TypeError When There Are No Nested Requirements [\#2590](https://github.com/hyperledger/aries-cloudagent-python/pull/2590) [Ennovate-com](https://github.com/Ennovate-com)
104+
- feat: use a local static cache for commonly used contexts [\#2587](https://github.com/hyperledger/aries-cloudagent-python/pull/2587) [chumbert](https://github.com/chumbert)
82105
- Issue #2488 KeyError raised when Subject ID is not a URI [\#2490](https://github.com/hyperledger/aries-cloudagent-python/pull/2490) [Ennovate-com](https://github.com/Ennovate-com)
83106
- Credential Exchange (Issue, Present) Updates
107+
- Default connection_id to None to account for Connectionless Proofs [\#2605](https://github.com/hyperledger/aries-cloudagent-python/pull/2605) [popkinj](https://github.com/popkinj)
108+
- Send Problem report when CredEx not found [\#2577](https://github.com/hyperledger/aries-cloudagent-python/pull/2577) [usingtechnology](https://github.com/usingtechnology)
84109
- fix: clean up requests and invites [\#2560](https://github.com/hyperledger/aries-cloudagent-python/pull/2560) [dbluhm](https://github.com/dbluhm)
85110
- Multitenancy Updates and Fixes
86111
- Feat: Support subwallet upgradation using the Upgrade command [\#2529](https://github.com/hyperledger/aries-cloudagent-python/pull/2529) [shaangill025](https://github.com/shaangill025)
87-
- Other Fixes, Demo, and Documentation Fixes
112+
- Other Fixes, Demo, DevContainer and Documentation Fixes
113+
- black formatter extension configuration update [\#2603](https://github.com/hyperledger/aries-cloudagent-python/pull/2603) [usingtechnology](https://github.com/usingtechnology)
114+
- Update Devcontainer pytest ruff black [\#2602](https://github.com/hyperledger/aries-cloudagent-python/pull/2602) [usingtechnology](https://github.com/usingtechnology)
115+
- Issue 2570 devcontainer ruff, black and pytest [\#2595](https://github.com/hyperledger/aries-cloudagent-python/pull/2595) [usingtechnology](https://github.com/usingtechnology)
116+
- chore: correct type hints on base record [\#2604](https://github.com/hyperledger/aries-cloudagent-python/pull/2604) [dbluhm](https://github.com/dbluhm)
88117
- Playground needs optionally external network [\#2564](https://github.com/hyperledger/aries-cloudagent-python/pull/2564) [usingtechnology](https://github.com/usingtechnology)
89118
- Issue 2555 playground scripts readme [\#2563](https://github.com/hyperledger/aries-cloudagent-python/pull/2563) [usingtechnology](https://github.com/usingtechnology)
90119
- Update demo/playground scripts [\#2562](https://github.com/hyperledger/aries-cloudagent-python/pull/2562) [usingtechnology](https://github.com/usingtechnology)
@@ -108,11 +137,13 @@ not set. See [PR \#2517]
108137
- Remove old routing protocol code [\#2466](https://github.com/hyperledger/aries-cloudagent-python/pull/2466) [dbluhm](https://github.com/dbluhm)
109138
- CI/CD, Testing, and Developer Tools/Productivity Updates
110139
- fix: drop asynctest 0.11.0 [\#2566](https://github.com/hyperledger/aries-cloudagent-python/pull/2566) [dbluhm](https://github.com/dbluhm)
140+
- Dockerfile.indy - Include aries_cloudagent code into build [\#2584](https://github.com/hyperledger/aries-cloudagent-python/pull/2584) [usingtechnology](https://github.com/usingtechnology)
111141
- fix: version should be set by pyproject.toml [\#2471](https://github.com/hyperledger/aries-cloudagent-python/pull/2471) [dbluhm](https://github.com/dbluhm)
112142
- chore: add black back in as a dev dep [\#2465](https://github.com/hyperledger/aries-cloudagent-python/pull/2465) [dbluhm](https://github.com/dbluhm)
113143
- Swap out flake8 in favor of Ruff [\#2438](https://github.com/hyperledger/aries-cloudagent-python/pull/2438) [dbluhm](https://github.com/dbluhm)
114144
- #2289 Migrate to Poetry [\#2436](https://github.com/hyperledger/aries-cloudagent-python/pull/2436) [Gavinok](https://github.com/Gavinok)
115145
- Release management pull requests
146+
- 0.11.0rc2 [\#2613](https://github.com/hyperledger/aries-cloudagent-python/pull/2613) [swcurran](https://github.com/swcurran)
116147
- 0.11.0-rc1 [\#2576](https://github.com/hyperledger/aries-cloudagent-python/pull/2576) [swcurran](https://github.com/swcurran)
117148
- 0.11.0-rc0 [\#2575](https://github.com/hyperledger/aries-cloudagent-python/pull/2575) [swcurran](https://github.com/swcurran)
118149

PUBLISHING.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ Once ready to do a release, create a local branch that includes the following up
2222
- Use a command like the following, adjusting the tag parameters as
2323
appropriate. `docker run -it --rm -v "$(pwd)":/usr/local/src/your-app
2424
githubchangeloggenerator/github-changelog-generator --user hyperledger
25-
--project aries-cloudagent-python --output 0.7.4-rc0.md --since-tag 0.7.3
26-
--future-release 0.7.4-rc0 --release-branch main --token <your-token>`
25+
--project aries-cloudagent-python --output 0.11.0rc2.md --since-tag 0.10.4
26+
--future-release 0.11.1rc2 --release-branch main --token <your-token>`
2727
- In the generated file, use only the PR list -- we don't include the list of
2828
closed issues in the Change Log.
2929

@@ -107,7 +107,9 @@ Once you have the list of PRs:
107107
version number should adhere to the [Semantic Versioning
108108
Specification](https://semver.org/#semantic-versioning-specification-semver)
109109
based on the changes since the last published release. For Release
110-
Candidates, the form of the tag is "0.7.2-rc0".
110+
Candidates, the form of the tag is "0.11.0rc2". As of release `0.11.0`
111+
we have dropped the previously used `-` in the release candidate version
112+
string to better follow the semver rules.
111113

112114
6. An extra search of the repo for the existing tag is recommended to see if
113115
there are any other instances of the tag in the repo. If any are found to be

docs/README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,10 @@ To rebuild the project and settings from scratch (you'll need to move the genera
3535

3636
See the **NOTE** above for the need for the use of docker in these steps.
3737

38-
``` bash
39-
alias sphinx-apidoc='docker run -it --rm -v ${PWD}:/docs sphinxdoc/sphinx sphinx-apidoc'
40-
cp -r ../aries_cloudagent .
41-
rm -rf generated
42-
# sphinx-apidoc -f -M -o ./generated ../aries_cloudagent/ $(find ../aries_cloudagent/ -name '*tests*')
43-
sphinx-apidoc -f -M -o ./generated ./aries_cloudagent/ $(find ./aries_cloudagent/ -name '*tests*')
44-
rm -rf ./aries_cloudagent
45-
unalias sphinx-apidoc
38+
If needed: `alias sphinx-apidoc='docker run -it --rm -v ${PWD}:/docs sphinxdoc/sphinx sphinx-apidoc'`
39+
40+
`cp -r ../aries_cloudagent .; rm -rf generated; sphinx-apidoc -f -M -o ./generated ./aries_cloudagent/ $(find ./aries_cloudagent/ -name '*tests*'); sudo chown -R $USER:$USER generated/; rm -rf ./aries_cloudagent`
41+
4642
```
4743
4844
Note that the `find` command that is used to exclude any of the `test` python files from the RTD documentation.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
aries\_cloudagent.vc.ld\_proofs.resources package
2+
=================================================
3+
4+
.. automodule:: aries_cloudagent.vc.ld_proofs.resources
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/generated/aries_cloudagent.vc.ld_proofs.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Subpackages
1414

1515
aries_cloudagent.vc.ld_proofs.crypto
1616
aries_cloudagent.vc.ld_proofs.purposes
17+
aries_cloudagent.vc.ld_proofs.resources
1718
aries_cloudagent.vc.ld_proofs.suites
1819

1920
Submodules
@@ -35,6 +36,14 @@ aries\_cloudagent.vc.ld\_proofs.constants module
3536
:undoc-members:
3637
:show-inheritance:
3738

39+
aries\_cloudagent.vc.ld\_proofs.document\_downloader module
40+
-----------------------------------------------------------
41+
42+
.. automodule:: aries_cloudagent.vc.ld_proofs.document_downloader
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
3847
aries\_cloudagent.vc.ld\_proofs.document\_loader module
3948
-------------------------------------------------------
4049

open-api/openapi.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"openapi" : "3.0.1",
33
"info" : {
44
"title" : "Aries Cloud Agent",
5-
"version" : "v0.11.0-rc1"
5+
"version" : "v0.11.0rc2"
66
},
77
"servers" : [ {
88
"url" : "/"

open-api/swagger.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"swagger" : "2.0",
33
"info" : {
4-
"version" : "v0.11.0-rc1",
4+
"version" : "v0.11.0rc2",
55
"title" : "Aries Cloud Agent"
66
},
77
"tags" : [ {

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "aries_cloudagent"
3-
version = "0.11.0-rc1"
3+
version = "0.11.0rc2"
44
description = "Hyperledger Aries Cloud Agent Python (ACA-Py) is a foundation for building decentralized identity applications and services running in non-mobile environments. "
55
authors = ["Hyperledger Aries <aries@lists.hyperledger.org>"]
66
license = "Apache-2.0"

0 commit comments

Comments
 (0)