Skip to content

Commit

Permalink
Merge pull request #3278 from swcurran/1.0.1
Browse files Browse the repository at this point in the history
1.0.1
  • Loading branch information
swcurran authored Oct 8, 2024
2 parents f8806fe + 2e64dec commit 06d1cf8
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 35 deletions.
42 changes: 13 additions & 29 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,25 @@
# Aries Cloud Agent Python Changelog

## 1.0.1rc1
## 1.0.1

### October 1, 2024
### October 8, 2024

Release 1.0.1 _might_ be the last release of ACA-Py from the Hyperledger
organization before the repository moves to the [OpenWallet Foundation] (OWF). As
noted in the repository [README.md](README.md), the ACA-Py project will soon be
moving soon to the OWF's GitHub organization as the [new "acapy"
project](https://github.com/openwallet-foundation/project-proposals/pull/42).
Release 1.0.1 will be the last release of ACA-Py from the Hyperledger organization before the repository moves to the [OpenWallet Foundation] (OWF). Soon after this release, the ACA-Py project and this repository will move to the OWF's GitHub organization as the [new "acapy" project](https://github.com/openwallet-foundation/project-proposals/blob/main/projects/aca-py.md).

[OpenWallet Foundation]: https://openwallet.foundation/

For details on what this 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

The release contains mostly internal clean ups, technical debt elimination, and
a revision to the integration testing approach, incorporating the [Aries Agent Test Harness] tests in the ACA-Py continuous integration testing process. There are substantial enhancements in the
management of keys and their use with [VC-DI] proofs, and web-based DID methods like
`did:web`. See the `Wallet and Key Handling` updates in the categorized PR list below.
The 1.0.1 release contains mostly internal clean ups, technical debt elimination, and a revision to the integration testing approach, incorporating the [Aries Agent Test Harness] tests in the ACA-Py continuous integration testing process. There are substantial enhancements in the management of keys and their use with [VC-DI] proofs, and web-based DID methods like `did:web`. See the `Wallet and Key Handling` updates in the categorized PR list below.

[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](#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.
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

Expand All @@ -38,16 +28,7 @@ list of those PRs.
[PyPi]: https://pypi.org
[GitHub Container Registry]: https://ghcr.io

- In the next ACA-Py release, we will be dropping from the core ACA-Py
repository the AIP 1.0 [RFC 0160 Connections], [RFC 0037 Issue Credentials
v1.0] and [RFC 0037 Present Proof v1.0] DIDComm protocols. Each of the
protocols will be moved to the [ACA-Py Plugins] repo. All deployers that use
those protocols **SHOULD** update to the [AIP 2.0] versions of those protocols
([RFC
0434 Out of Band]+[RFC 0023 DID Exchange], [RFC 0453 Issue Credential v2.0]
and [RFC 0454 Present Proof v2.0], respectively). Once the protocols are
removed from ACA-Py, anyone still using those protocols must adjust their
configuration to load those protocols from the respective plugins.
- In the next ACA-Py release, we will be dropping from the core ACA-Py repository the AIP 1.0 [RFC 0160 Connections], [RFC 0037 Issue Credentials v1.0] and [RFC 0037 Present Proof v1.0] DIDComm protocols. Each of the protocols will be moved to the [ACA-Py Plugins] repo. All deployers that use those protocols **SHOULD** update to the [AIP 2.0] versions of those protocols ([RFC 0434 Out of Band]+[RFC 0023 DID Exchange], [RFC 0453 Issue Credential v2.0] and [RFC 0454 Present Proof v2.0], respectively). Once the protocols are removed from ACA-Py, anyone still using those protocols **MUST** adjust their configuration to load those protocols from the respective plugins.

[RFC 0160 Connections]: https://hyperledger.github.io/aries-rfcs/latest/features/0160-connection-protocol/
[RFC 0037 Issue Credentials]: https://hyperledger.github.io/aries-rfcs/latest/features/0036-issue-credential/
Expand All @@ -58,11 +39,11 @@ list of those PRs.
[RFC 0453 Issue Credential v2.0]: https://hyperledger.github.io/aries-rfcs/latest/aip2/0453-issue-credential-v2/
[RFC 0454 Present Proof v2.0]: https://hyperledger.github.io/aries-rfcs/latest/aip2/0454-present-proof-v2/

### 1.0.1rc1 Breaking Changes
### 1.0.1 Breaking Changes

There are no breaking changes in ACA-Py Release 1.0.1.

#### 1.0.1rc1 Categorized List of Pull Requests
#### 1.0.1 Categorized List of Pull Requests

- Wallet and Key Handling Updates
- Data integrity routes [\#3261](https://github.com/hyperledger/aries-cloudagent-python/pull/3261) [PatStLouis](https://github.com/PatStLouis)
Expand All @@ -79,6 +60,8 @@ There are no breaking changes in ACA-Py Release 1.0.1.
- :art: fix type hints for optional method parameters [\#3234](https://github.com/hyperledger/aries-cloudagent-python/pull/3234) [ff137](https://github.com/ff137)

- Documentation and GHA Test Updates
- Prevent integration tests on forks [\#3276](https://github.com/hyperledger/aries-cloudagent-python/pull/3276) [jamshale](https://github.com/jamshale)
- :memo Fix typos in PUBLISHING.md [\#3274](https://github.com/hyperledger/aries-cloudagent-python/pull/3274) [claudiotorrens](https://github.com/claudiotorrens)
- Fix scenario tests [\#3231](https://github.com/hyperledger/aries-cloudagent-python/pull/3231) [jamshale](https://github.com/jamshale)
- Only run integration tests on correct file changes [\#3230](https://github.com/hyperledger/aries-cloudagent-python/pull/3230) [jamshale](https://github.com/jamshale)
- Update docs for outstanding anoncreds work [\#3229](https://github.com/hyperledger/aries-cloudagent-python/pull/3229) [jamshale](https://github.com/jamshale)
Expand All @@ -101,11 +84,12 @@ There are no breaking changes in ACA-Py Release 1.0.1.
- [ POST v1.0.0 ] Adjust message queue error handling [\#3170](https://github.com/hyperledger/aries-cloudagent-python/pull/3170) [jamshale](https://github.com/jamshale)

- Release management pull requests:
- 1.0.1 [\#3278](https://github.com/hyperledger/aries-cloudagent-python/pull/3278) [swcurran](https://github.com/swcurran)
- 1.0.1rc1 [\#3268](https://github.com/hyperledger/aries-cloudagent-python/pull/3268) [swcurran](https://github.com/swcurran)
- 1.0.1rc0 [\#3254](https://github.com/hyperledger/aries-cloudagent-python/pull/3254) [swcurran](https://github.com/swcurran)

- Dependabot PRs
- [Link to list of Dependabot PRs in this release](https://github.com/hyperledger/aries-cloudagent-python/pulls?q=is%3Apr+is%3Amerged+merged%3A2024-08-15..2024-10-01+author%3Aapp%2Fdependabot+)
- [Link to list of Dependabot PRs in this release](https://github.com/hyperledger/aries-cloudagent-python/pulls?q=is%3Apr+is%3Amerged+merged%3A2024-08-15..2024-10-08+author%3Aapp%2Fdependabot+)

## 1.0.0

Expand Down
2 changes: 1 addition & 1 deletion Managing-ACA-Py-Doc-Site.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.1rc1`).
- Checks out the triggering branch, either `main` or `docs-v<version>` (e.g `docs-v1.0.1`).
- 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
Expand Down
2 changes: 1 addition & 1 deletion PUBLISHING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.1rc1".
1. Create a local PR branch from an updated `main` branch, e.g. "1.0.1".

2. See if there are any Document Site `mkdocs` changes needed. Run the script
`./scripts/prepmkdocs.sh; mkdocs`. Watch the log, noting particularly if
Expand Down
2 changes: 1 addition & 1 deletion docs/features/SupportedRFCs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ ACA-Py or the repository `main` branch. Reminders (and PRs!) to update this page
welcome! If you have any questions, please contact us on the #aries channel on
[Hyperledger Discord](https://discord.gg/hyperledger) or through an issue in this repo.

**Last Update**: 2024-10-01, Release 1.0.1rc1
**Last Update**: 2024-10-08, Release 1.0.1

> The checklist version of this document was created as a joint effort
> between [Northern Block](https://northernblock.io/), [Animo Solutions](https://animo.id/) and the Ontario government, on behalf of the Ontario government.
Expand Down
2 changes: 1 addition & 1 deletion open-api/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi" : "3.0.1",
"info" : {
"title" : "Aries Cloud Agent",
"version" : "v1.0.1rc1"
"version" : "v1.0.1"
},
"servers" : [ {
"url" : "/"
Expand Down
2 changes: 1 addition & 1 deletion open-api/swagger.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"swagger" : "2.0",
"info" : {
"version" : "v1.0.1rc1",
"version" : "v1.0.1",
"title" : "Aries Cloud Agent"
},
"tags" : [ {
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "aries_cloudagent"
version = "1.0.1rc1"
version = "1.0.1"
description = "Hyperledger Aries Cloud Agent Python (ACA-Py) is a foundation for building decentralized identity applications and services running in non-mobile environments. "
authors = ["Hyperledger Aries <[email protected]>"]
license = "Apache-2.0"
Expand Down

0 comments on commit 06d1cf8

Please sign in to comment.