Skip to content

Commit

Permalink
Merge pull request #3254 from swcurran/1.0.1rc0
Browse files Browse the repository at this point in the history
  • Loading branch information
swcurran authored Sep 26, 2024
2 parents d3644da + 4912b6b commit dc66c82
Show file tree
Hide file tree
Showing 13 changed files with 589 additions and 108 deletions.
99 changes: 99 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,104 @@
# Aries Cloud Agent Python Changelog

## 1.0.1rc0

### September 25, 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).

[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.

[Aries Agent Test Harness]: https://github.com/hyperledger/aries-agent-test-harness

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.

#### Deprecation Notices

- ACA-Py will soon be moved from the Hyperledger GitHub organization to that of the [OpenWallet Foundation]. As such, there will be changes in the names and locations of the artifacts produced -- the [PyPi] project and the container images in the [GitHub Container Registry]. We will retain the ability to publish LTS releases of ACA-Py for the current LTS versions (0.11, 0.12) in the current locations. For details, guidance, timing, and progress on the move, please monitor the description of [GitHub Issue #3250] that will be maintained throughout the process.

[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.

[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/
[RFC 0037 Present Proof]: https://hyperledger.github.io/aries-rfcs/latest/features/0037-present-proof/
[AIP 2.0]: https://hyperledger.github.io/aries-rfcs/latest/aip2/0003-protocols/
[RFC 0434 Out of Band]: https://hyperledger.github.io/aries-rfcs/latest/aip2/0434-outofband/
[RFC 0023 DID Exchange]: https://hyperledger.github.io/aries-rfcs/latest/aip2/0023-did-exchange/
[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.1rc0 Breaking Changes

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

#### 1.0.1rc0 Categorized List of Pull Requests

- Wallet and Key Handling Updates
- Feature multikey management [\#3246](https://github.com/hyperledger/aries-cloudagent-python/pull/3246) [PatStLouis](https://github.com/PatStLouis)
- chore: delete unused keypair storage manager [\#3245](https://github.com/hyperledger/aries-cloudagent-python/pull/3245) [dbluhm](https://github.com/dbluhm)

- Credential Exchange Updates
- feat: verify creds signed with Ed25519VerificationKey2020 [\#3244](https://github.com/hyperledger/aries-cloudagent-python/pull/3244) [dbluhm](https://github.com/dbluhm)
- Add anoncreds profile basic scenario test [\#3232](https://github.com/hyperledger/aries-cloudagent-python/pull/3232) [jamshale](https://github.com/jamshale)
- fix: anoncreds revocation notification when revoking [\#3226](https://github.com/hyperledger/aries-cloudagent-python/pull/3226) [thiagoromanos](https://github.com/thiagoromanos)

- OpenAPI Updates
- :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
- 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)
- Only change interop testing fork on pull requests [\#3218](https://github.com/hyperledger/aries-cloudagent-python/pull/3218) [jamshale](https://github.com/jamshale)
- Remove the RC from the versions table [\#3213](https://github.com/hyperledger/aries-cloudagent-python/pull/3213) [swcurran](https://github.com/swcurran)
- Document the documentation site generation process [\#3212](https://github.com/hyperledger/aries-cloudagent-python/pull/3212) [swcurran](https://github.com/swcurran)
- Remove 1.0.0rc6 documentation from gh-pages [\#3211](https://github.com/hyperledger/aries-cloudagent-python/pull/3211) [swcurran](https://github.com/swcurran) - Adjust nightly and release workflows [\#3210](https://github.com/hyperledger/aries-cloudagent-python/pull/3210) [jamshale](https://github.com/jamshale)
- Change interop tests to critical on PRs [\#3209](https://github.com/hyperledger/aries-cloudagent-python/pull/3209) [jamshale](https://github.com/jamshale)
- Change integration testing [\#3194](https://github.com/hyperledger/aries-cloudagent-python/pull/3194) [jamshale](https://github.com/jamshale)

- Dependencies and Internal Fixes/Updates:
- Removing padding from url invitations [\#3238](https://github.com/hyperledger/aries-cloudagent-python/pull/3238) [jamshale](https://github.com/jamshale)
- Ensure that DAP_PORT is always an int [\#3241](https://github.com/hyperledger/aries-cloudagent-python/pull/3241) [Gavinok](https://github.com/Gavinok)
- Fix logic to send verbose webhooks [\#3193](https://github.com/hyperledger/aries-cloudagent-python/pull/3193) [ianco](https://github.com/ianco)
- fixes #3186: handler_timed_file_handler [\#3187](https://github.com/hyperledger/aries-cloudagent-python/pull/3187) [rngadam](https://github.com/rngadam)
- issue #3182: replace deprecated ptvsd debugger by debugpy [\#3183](https://github.com/hyperledger/aries-cloudagent-python/pull/3183) [rngadam](https://github.com/rngadam)
- 👷Publish `aries-cloudagent-bbs` Docker image [\#3175](https://github.com/hyperledger/aries-cloudagent-python/pull/3175) [rblaine95](https://github.com/rblaine95)
- [ 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.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-09-25+author%3Aapp%2Fdependabot+)

## 1.0.0

### August 16, 2024
Expand Down
92 changes: 31 additions & 61 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,45 +2,14 @@

## Maintainer Scopes, GitHub Roles and GitHub Teams

Maintainers are assigned the following scopes in this repository:

| Scope | Definition | GitHub Role | GitHub Team |
| ---------- | ------------------------ | ----------- | ------------------------------------ |
| Admin | | Admin | [aries-admins] |
| Maintainer | The GitHub Maintain role | Maintain | [aries-cloudagent-python committers] |
| Triage | The GitHub Triage role | Triage | [aries triage] |
| Read | The GitHub Read role | Read | [Aries Contributors] |
| Read | The GitHub Read role | Read | [TOC] |
| Read | The GitHub Read role | Read | [aries-framework-go-ext committers] |

[aries-admins]: https://github.com/orgs/hyperledger/teams/aries-admins
[aries-cloudagent-python committers]: https://github.com/orgs/hyperledger/teams/aries-cloudagent-python-committers
[aries triage]: https://github.com/orgs/hyperledger/teams/aries-triage
[Aries Contributors]: https://github.com/orgs/hyperledger/teams/aries-contributors
[TOC]: https://github.com/orgs/hyperledger/teams/toc
[aries-framework-go-ext committers]: https://github.com/orgs/hyperledger/teams/aries-framework-go-ext-committers

## Active Maintainers

<!-- Please keep this sorted alphabetically by github -->

| GitHub ID | Name | Scope | LFID | Discord ID | Email | Company Affiliation |
| --------------- | ---------------- | ---------- | ---- | ---------- | ------------------------ | ------------------- |
| andrewwhitehead | Andrew Whitehead | Admin | | | [email protected] | BC Gov |
| dbluhm | Daniel Bluhm | Admin | | | [email protected] | Indicio PBC |
| dhh1128 | Daniel Hardman | Admin | | | [email protected] | Provident |
| shaangill025 | Shaanjot Gill | Maintainer | | | [email protected] | BC Gov |
| swcurran | Stephen Curran | Admin | | | [email protected] | BC Gov |
| TelegramSam | Sam Curren | Maintainer | | | [email protected] | Indicio PBC |
| TimoGlastra | Timo Glastra | Admin | | | [email protected] | Animo Solutions |
| WadeBarnes | Wade Barnes | Admin | | | [email protected] | BC Gov |
| usingtechnology | Jason Sherman | Maintainer | | | [email protected] | BC Gov |

## Emeritus Maintainers

| Name | GitHub ID | Scope | LFID | Discord ID | Email | Company Affiliation |
|----- | --------- | ----- | ---- | ---------- | ----- | ------------------- |
| | | | | | | |
The Maintainers of this repo, defined as GitHub users with escalated privileges
in the repo, are managed in the Hyperledger "governance" repo's [access-control.yaml](https://github.com/hyperledger/governance/blob/main/access-control.yaml) file. Consult that to see:

- What teams have escalated privileges to this repository.
- What GitHub roles those teams have in the repository.
- Who are the members of each of those teams.

The actions covered below for [becoming](#becoming-a-maintainer) and [removing](#removing-maintainers) are made manifest through PRs to that file.

## The Duties of a Maintainer

Expand Down Expand Up @@ -74,18 +43,18 @@ occur, roughly in order.
- The proposed maintainer establishes their reputation in the community,
including authoring five (5) significant merged pull requests, and expresses
an interest in becoming a maintainer for the repository.
- A PR is created to update this file to add the proposed maintainer to the list of active maintainers.
- The PR is authored by an existing maintainer or has a comment on the PR from an existing maintainer supporting the proposal.
- The PR is authored by the proposed maintainer or has a comment on the PR from the proposed maintainer confirming their interest in being a maintainer.
- The PR or comment from the proposed maintainer must include their
- An issue is created to add the proposed maintainer to the list of active maintainers.
- The issue is authored by an existing maintainer or has a comment on the PR from an existing maintainer supporting the proposal.
- The issue is authored by the proposed maintainer or has a comment on the issue from the proposed maintainer confirming their interest in being a maintainer.
- The issue or comment from the proposed maintainer must include their
willingness to be a long-term (more than 6 month) maintainer.
- Once the PR and necessary comments have been received, an approval timeframe begins.
- The PR **MUST** be communicated on all appropriate communication channels, including relevant community calls, chat channels and mailing lists. Comments of support from the community are welcome.
- The PR is merged and the proposed maintainer becomes a maintainer if either:
- Two weeks have passed since at least three (3) Maintainer PR approvals have been recorded, OR
- An absolute majority of maintainers have approved the PR.
- If the PR does not get the requisite PR approvals, it may be closed.
- Once the add maintainer PR has been merged, any necessary updates to the GitHub Teams are made.
- Once the issue and necessary comments have been received, an approval timeframe begins.
- The issue **MUST** be communicated on all appropriate communication channels, including relevant community calls, chat channels and mailing lists. Comments of support from the community are welcome.
- The issue is approved and the proposed maintainer becomes a maintainer if either:
- Two weeks have passed since at least three (3) Maintainer issue approvals have been recorded, OR
- An absolute majority of maintainers have approved the issue.
- If the issue does not get the requisite approvals, it may be closed.
- Once the add maintainer issue has been approved, the necessary updates to the GitHub Teams are made via a PR to the Hyperledger "governance" repo's [access-control.yaml](https://github.com/hyperledger/governance/blob/main/access-control.yaml) file.

## Removing Maintainers

Expand All @@ -104,17 +73,18 @@ maintainer to emeritus status. This can occur in the following situations:
- Other circumstances at the discretion of the other Maintainers.

The process to move a maintainer from active to emeritus status is comparable to the process for adding a maintainer, outlined above. In the case of voluntary
resignation, the Pull Request can be merged following a maintainer PR approval. If the removal is for any other reason, the following steps **SHOULD** be followed:

- A PR is created to update this file to move the maintainer to the list of emeritus maintainers.
- The PR is authored by, or has a comment supporting the proposal from, an existing maintainer or Hyperledger GitHub organization administrator.
- Once the PR and necessary comments have been received, the approval timeframe begins.
- The PR **MAY** be communicated on appropriate communication channels, including relevant community calls, chat channels and mailing lists.
- The PR is merged and the maintainer transitions to maintainer emeritus if:
- The PR is approved by the maintainer to be transitioned, OR
- Two weeks have passed since at least three (3) Maintainer PR approvals have been recorded, OR
- An absolute majority of maintainers have approved the PR.
- If the PR does not get the requisite PR approvals, it may be closed.
resignation, the Pull Request can be merged following a maintainer issue approval. If the removal is for any other reason, the following steps **SHOULD** be followed:

- An issue is created to move the maintainer to the list of emeritus maintainers.
- The issue is authored by, or has a comment supporting the proposal from, an existing maintainer or Hyperledger GitHub organization administrator.
- Once the issue and necessary comments have been received, the approval timeframe begins.
- The issue **MAY** be communicated on appropriate communication channels, including relevant community calls, chat channels and mailing lists.
- The issue is approved and the maintainer transitions to maintainer emeritus if:
- The issue is approved by the maintainer to be transitioned, OR
- Two weeks have passed since at least three (3) Maintainer issue approvals have been recorded, OR
- An absolute majority of maintainers have approved the issue.
- If the issue does not get the requisite approvals, it may be closed.
- Once the remove maintainer issue has been approved, the necessary updates to the GitHub Teams are made via a PR to the Hyperledger "governance" repo's [access-control.yaml](https://github.com/hyperledger/governance/blob/main/access-control.yaml) file.

Returning to active status from emeritus status uses the same steps as adding a
new maintainer. Note that the emeritus maintainer already has the 5 required
Expand Down
4 changes: 2 additions & 2 deletions 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.0`).
- Checks out the triggering branch, either `main` or `docs-v<version>` (e.g `docs-v1.0.1rc0`).
- 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 Expand Up @@ -97,7 +97,7 @@ To delete the documentation version, do the following:
- Check your `git status` and make sure there are no changes in the branch --
e.g., new files that shouldn't be added to the `gh-pages` branch. If there are
any -- delete the files so they are not added.
- Remove the folder for the RC. For example `rm -rf 1.0.0rc4`
- Remove the folder for the RC. For example `rm -rf 1.0.1rc0`
- Edit the `versions.json` file and remove the reference to the RC release in
the file.
- Push the changes via a PR to the ACA-Py `gh-pages` branch (don't PR them into
Expand Down
Loading

0 comments on commit dc66c82

Please sign in to comment.