Skip to content

Commit f0b2719

Browse files
authored
Merge pull request openwallet-foundation#1849 from swcurran/0.7.4
0.7.4 Release Changelog and version update
2 parents b46e7dc + 1141251 commit f0b2719

4 files changed

Lines changed: 66 additions & 52 deletions

File tree

CHANGELOG.md

Lines changed: 63 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,34 @@
1-
# 0.7.4-RC5
1+
# 0.7.4
22

3-
## June 23, 2022
3+
## June 30, 2022
44

5-
**NOTE** We expect 0.7.4-rc5 will the be the last Release Candidate prior to the
6-
official 0.7.4 release.
5+
0.7.4 is a significant release focused on stability and production deployments.
6+
As the "patch" release number indicates, there were no breaking changes in the
7+
Admin API, but a huge volume of updates and improvements. Highlights of this
8+
release include:
79

8-
**NOTE:** 0.7.4-rc4 contains a fix for a revocation-related issue introduced in
9-
0.7.4-rc3. We recommend updating to 0.7.4-rc4 immediately if you have been using
10-
0.7.4-rc3.
10+
- A major performance and stability improvement resulting from the now
11+
recommended use of [Aries Askar](https://github.com/bcgov/aries-askar) instead
12+
of the Indy-SDK.
13+
- There are significant improvements and tools for dealing with
14+
revocation-related issues.
15+
- A lot of work has been on the handling of Hyperledger Indy transaction
16+
endorsements.
17+
- ACA-Py now has a pluggable persistent queues mechanism in place, with Redis
18+
and Kafka support available (albeit with work still to come on documentation).
1119

12-
- See issue: [\#1823](https://github.com/hyperledger/aries-cloudagent-python/issues/1823)
13-
- See Pull Request: [\#1827](https://github.com/hyperledger/aries-cloudagent-python/pull/1827)
20+
In addition, there are a significant number of general enhancements, bug fixes,
21+
documentation updates and code management improvements.
1422

15-
The 0.7.4 release consists largely of internal fixes to ACA-Py, big increases in
16-
performance resulting from the now recommended use of [Aries
17-
Askar](https://github.com/bcgov/aries-askar) instead of the Indy-SDK,
18-
improvements and tools for dealing with revocation-related issues, plus a number
19-
of general enhancements. There have been a lot of groups exercising ACA-Py and the
20-
updates made in this release are a reflection of those efforts. We have PRs that
21-
have been contributed by 21 different people.
23+
This release is a reflection of the many groups stressing ACA-Py in production
24+
environments, reporting issues and the resulting solutions. We also have a very
25+
large number of contributors to ACA-Py, with this release having PRs from 22
26+
different individuals. A big thank you to all of those using ACA-Py, raising
27+
issues and providing solutions.
2228

23-
The largest enhancement is in the area of the endorsing of Hyperledger Indy
24-
ledger transactions, enabling an instance of ACA-Py to act as an Endorser for
25-
Indy authors needing endorsements to write objects to an Indy ledger. We're
26-
hoping to see (and working on!) an "aries-endorser-service" come from that work,
27-
an Endorser to be easily operated by an organization, ideally with a controller
28-
starter kit supporting a basic approvals business workflow.
29-
30-
A focus towards the end of the 0.7.4 development and release cycle was on the
31-
handling of AnonCreds revocation in ACA-Py. Most important, a production issue
32-
was uncovered where by an ACA-Py issuer's local Revocation Registry data could
33-
get out of sync with what was published on an Indy ledger, resulting in an
34-
inability to publish new RevRegEntry transactions -- making new revocations
35-
impossible. As a result, we have added some new endpoints to enable an update to
36-
the RevReg storage such that RevRegEntry transactions can again be published to
37-
the ledger. Other changes were added related to revocation in general
38-
and in the handling of tails files in particular.
29+
### Major Enhancements
3930

40-
A lot of work has been put in for this release related to performance and load
31+
A lot of work has been put into this release related to performance and load
4132
testing, with significant updates being made to the key "shared component"
4233
ACA-Py dependencies ([Aries Askar](https://github.com/bcgov/aries-askar), [Indy
4334
VDR](https://github.comyperledger/indy-vdr)) and [Indy Shared RS (including
@@ -51,15 +42,36 @@ especially the team at LISSI for creating the
5142
to make load testing so easy! And of course to the core ACA-Py team for
5243
addressing the findings.
5344

45+
The largest enhancement is in the area of the endorsing of Hyperledger Indy
46+
ledger transactions, enabling an instance of ACA-Py to act as an Endorser for
47+
Indy authors needing endorsements to write objects to an Indy ledger. We're
48+
working on an [Aries Endorser
49+
Service](https://github.com/bcgov/aries-endorser-service) based on the new
50+
capabilities in ACA-Py, an Endorser to be easily operated by an organization,
51+
ideally with a controller starter kit supporting a basic human and automated
52+
approvals business workflow. Contributions welcome!
53+
54+
A focus towards the end of the 0.7.4 development and release cycle was on the
55+
handling of AnonCreds revocation in ACA-Py. Most important, a production issue
56+
was uncovered where by an ACA-Py issuer's local Revocation Registry data could
57+
get out of sync with what was published on an Indy ledger, resulting in an
58+
inability to publish new RevRegEntry transactions -- making new revocations
59+
impossible. As a result, we have added some new endpoints to enable an update to
60+
the RevReg storage such that RevRegEntry transactions can again be published to
61+
the ledger. Other changes were added related to revocation in general
62+
and in the handling of tails files in particular.
63+
5464
The team has worked a lot on evolving the persistent queue (PQ) approach
55-
available in ACA-Py. We have landed on a design whereby the ability to use
56-
queues for inbound and outbound messages is within ACA-Py, with a default
57-
in-memory implementation, and the implementations of external persistent queues
58-
solutions is handled by referencing a plugin from a separate repository. There
59-
will shortly be two concrete, out-of-the-box solutions available, one for Kafka
60-
and one for Redis, and anyone else can implement their own PQ plugin as long as
61-
it uses the same ACA-Py queuing interface. Look for the new PQ repos shortly
62-
within Hyperledger Aries.
65+
available in ACA-Py. We have landed on a design for the queues for inbound and
66+
outbound messages using a default in-memory implementation, and the ability to
67+
replace the default method with implementations created via an ACA-Py plugin.
68+
There are two concrete, out-of-the-box external persistent queuing solutions
69+
available for [Redis](https://github.com/bcgov/aries-acapy-plugin-redis-events)
70+
and [Kafka](https://github.com/sicpa-dlab/aries-acapy-plugin-kafka-events).
71+
Those ACA-Py persistent queue implementation repositories will soon be migrated
72+
to the Aries project within the Hyperledger Foundation's GitHub organization.
73+
Anyone else can implement their own queuing plugin as long as it uses the same
74+
interface.
6375

6476
Several new ways to control ACA-Py configurations were added, including new
6577
startup parameters, Admin API parameters to control instances of protocols, and
@@ -71,7 +83,9 @@ there no changes in the APIs.
7183

7284
As well there were a number of internal fixes, dependency updates, documentation
7385
and demo changes, developer tools and release management updates. All the usual
74-
stuff needed for a growing codebase.
86+
stuff needed for a healthy, growing codebase.
87+
88+
### Categorized List of Pull Requests
7589

7690
- Hyperledger Indy Endorser related updates:
7791
- Fix order of operations connecting faber to endorser [\#1716](https://github.com/hyperledger/aries-cloudagent-python/pull/1716) ([ianco](https://github.com/ianco))
@@ -100,6 +114,7 @@ stuff needed for a growing codebase.
100114
- Redis PQ Cleanup in preparation for enabling the uses of plugin PQ implementations \[Issue\#1659\] [\#1659](https://github.com/hyperledger/aries-cloudagent-python/pull/1690) ([shaangill025](https://github.com/shaangill025))
101115

102116
- Credential Revocation and Tails File Handling
117+
- Fix handling of non-revocable credential when timestamp is specified \(askar/credx\) [\#1847](https://github.com/hyperledger/aries-cloudagent-python/pull/1847) ([andrewwhitehead](https://github.com/andrewwhitehead))
103118
- Additional endpoints to get revocation details and fix "published" status [\#1783](https://github.com/hyperledger/aries-cloudagent-python/pull/1783) ([ianco](https://github.com/ianco))
104119
- Fix IssuerCredRevRecord state update on revocation publish [\#1827](https://github.com/hyperledger/aries-cloudagent-python/pull/1827) ([andrewwhitehead](https://github.com/andrewwhitehead))
105120
- Fix put_file when the server returns a redirect [\#1808](https://github.com/hyperledger/aries-cloudagent-python/pull/1808) ([andrewwhitehead](https://github.com/andrewwhitehead))
@@ -157,13 +172,9 @@ stuff needed for a growing codebase.
157172
- Replace async workaround within document loader [\#1774](https://github.com/hyperledger/aries-cloudagent-python/pull/1774) ([frostyfrog](https://github.com/frostyfrog))
158173

159174
- Documentation and Demo Updates
160-
- Changelog, version and ReadTheDocs updates for 0.7.4-rc3 release [\#1817](https://github.com/hyperledger/aries-cloudagent-python/pull/1817) ([swcurran](https://github.com/swcurran))
161-
- 0.7.4-rc2 update [\#1771](https://github.com/hyperledger/aries-cloudagent-python/pull/1771) ([swcurran](https://github.com/swcurran))
162-
- Some ReadTheDocs File updates [\#1770](https://github.com/hyperledger/aries-cloudagent-python/pull/1770) ([swcurran](https://github.com/swcurran))
163-
- 0.7.4-RC1 Changelog intro paragraph - fix copy/paste error [\#1753](https://github.com/hyperledger/aries-cloudagent-python/pull/1753) ([swcurran](https://github.com/swcurran))
164-
- Fixing the intro paragraph and heading in the changelog of this 0.7.4RC1 [\#1752](https://github.com/hyperledger/aries-cloudagent-python/pull/1752) ([swcurran](https://github.com/swcurran))
165-
- Updates to Changelog for 0.7.4. RC1 release [\#1747](https://github.com/hyperledger/aries-cloudagent-python/pull/1747) ([swcurran](https://github.com/swcurran))
166-
- Prep for adding the 0.7.4-rc0 tag [\#1722](https://github.com/hyperledger/aries-cloudagent-python/pull/1722) ([swcurran](https://github.com/swcurran))
175+
- Use default wallet type askar for alice/faber demo and bdd tests [\#1761](https://github.com/hyperledger/aries-cloudagent-python/pull/1761) ([ianco](https://github.com/ianco))
176+
- Update the Supported RFCs document for 0.7.4 release [\#1846](https://github.com/hyperledger/aries-cloudagent-python/pull/1846) ([swcurran](https://github.com/swcurran))
177+
- Fix a typo in DevReadMe.md [\#1844](https://github.com/hyperledger/aries-cloudagent-python/pull/1844) ([feknall](https://github.com/feknall))
167178
- Add troubleshooting document, include initial examples - ledger connection, out-of-sync RevReg [\#1818](https://github.com/hyperledger/aries-cloudagent-python/pull/1818) ([swcurran](https://github.com/swcurran))
168179
- Update POST /present-proof/send-request to POST /present-proof-2.0/send-request [\#1824](https://github.com/hyperledger/aries-cloudagent-python/pull/1824) ([lineko](https://github.com/lineko))
169180
- Fetch from --genesis-url likely to fail in composed container [\#1746](https://github.com/hyperledger/aries-cloudagent-python/pull/1739) ([tdiesler](https://github.com/tdiesler))
@@ -176,15 +187,18 @@ stuff needed for a growing codebase.
176187
- Document impact of multi-ledger on TAA acceptance [\#1778](https://github.com/hyperledger/aries-cloudagent-python/pull/1778) ([ianco](https://github.com/ianco))
177188

178189
- Code management and contributor/developer support updates
190+
- Set prefix for integration test demo agents; some code cleanup [\#1840](https://github.com/hyperledger/aries-cloudagent-python/pull/1840) ([andrewwhitehead](https://github.com/andrewwhitehead))
179191
- Pin markupsafe at version 2.0.1 [\#1642](https://github.com/hyperledger/aries-cloudagent-python/pull/1642) ([andrewwhitehead](https://github.com/andrewwhitehead))
180192
- style: format with stable black release [\#1615](https://github.com/hyperledger/aries-cloudagent-python/pull/1615) ([TimoGlastra](https://github.com/TimoGlastra))
181193
- Remove references to play with von [\#1688](https://github.com/hyperledger/aries-cloudagent-python/pull/1688) ([ianco](https://github.com/ianco))
182194
- Add pre-commit as optional developer tool [\#1671](https://github.com/hyperledger/aries-cloudagent-python/pull/1671) ([dbluhm](https://github.com/dbluhm))
183195
- run_docker start - pass environment variables [\#1715](https://github.com/hyperledger/aries-cloudagent-python/pull/1715) ([shaangill025](https://github.com/shaangill025))
184196
- Use local deps only [\#1834](https://github.com/hyperledger/aries-cloudagent-python/pull/1834) ([ryjones](https://github.com/ryjones))
185197
- Enable pip-audit [\#1831](https://github.com/hyperledger/aries-cloudagent-python/pull/1831) ([ryjones](https://github.com/ryjones))
198+
- Only run pip-audit on main repo [\#1845](https://github.com/hyperledger/aries-cloudagent-python/pull/1845) ([ryjones](https://github.com/ryjones))
186199

187200
- Release management pull requests
201+
- 0.7.4 Release Changelog and version update [\#1849](https://github.com/hyperledger/aries-cloudagent-python/pull/1849) ([swcurran](https://github.com/swcurran))
188202
- 0.7.4-rc5 changelog, version and ReadTheDocs updates [\#1838](https://github.com/hyperledger/aries-cloudagent-python/pull/1838) ([swcurran](https://github.com/swcurran))
189203
- Update changelog and version for 0.7.4-rc4 [\#1830](https://github.com/hyperledger/aries-cloudagent-python/pull/1830) ([swcurran](https://github.com/swcurran))
190204
- Changelog, version and ReadTheDocs updates for 0.7.4-rc3 release [\#1817](https://github.com/hyperledger/aries-cloudagent-python/pull/1817) ([swcurran](https://github.com/swcurran))

PUBLISHING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Once ready to do a release, create a local branch that includes the following up
88

99
1. Create a PR branch from an updated `main` branch.
1010

11-
2. Update the CHANGELOG.md to add the new release. If transitioning for a Release Candidate to the final release for the tag, do not create a new section -- just drop the "RC" designation. Check the date of the new release.
11+
2. Update the CHANGELOG.md to add the new release. Only create a new section when working on the first release candidate for a new release. When transitioning from one release candidate to the next, or to an official release, just update the title and date of the change log section.
1212

1313
3. Include details of the merged PRs included in this release. General process to follow:
1414

aries_cloudagent/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
"""Library version information."""
22

3-
__version__ = "0.7.4-rc5"
3+
__version__ = "0.7.4"
44
RECORD_TYPE_ACAPY_VERSION = "acapy_version"

open-api/openapi.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.7.4-rc5",
4+
"version" : "v0.7.4",
55
"title" : "Aries Cloud Agent"
66
},
77
"tags" : [ {

0 commit comments

Comments
 (0)