Skip to content

Commit 76ac265

Browse files
authored
* 1.3.0rc0 Signed-off-by: Stephen Curran <swcurran@gmail.com> * Additional Changelog notes Signed-off-by: Stephen Curran <swcurran@gmail.com> * Add PR to the list Signed-off-by: Stephen Curran <swcurran@gmail.com> * Adjustments to the API changes section Signed-off-by: Stephen Curran <swcurran@gmail.com> --------- Signed-off-by: Stephen Curran <swcurran@gmail.com>
1 parent e0f778a commit 76ac265

File tree

10 files changed

+1246
-1136
lines changed

10 files changed

+1246
-1136
lines changed

CHANGELOG.md

Lines changed: 264 additions & 38 deletions
Large diffs are not rendered by default.

Managing-ACA-Py-Doc-Site.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ and mkdocs configuration.
2020

2121
When the GitHub Action fires, it runs a container that carries out the following steps:
2222

23-
- Checks out the triggering branch, either `main` or `docs-v<version>` (e.g `docs-v1.2.1`).
23+
- Checks out the triggering branch, either `main` or `docs-v<version>` (e.g `docs-v1.3.0`).
2424
- Runs the script [scripts/prepmkdocs.sh], which moves and updates some of the
2525
markdown files so that they fit into the generated site. See the comments in
2626
the scripts for details about the copying and editing done via the script. In
@@ -97,7 +97,7 @@ To delete the documentation version, do the following:
9797
- Check your `git status` and make sure there are no changes in the branch --
9898
e.g., new files that shouldn't be added to the `gh-pages` branch. If there are
9999
any -- delete the files so they are not added.
100-
- Remove the folder for the RC. For example `rm -rf 1.2.1rc0`
100+
- Remove the folder for the RC. For example `rm -rf 1.3.0rc0`
101101
- Edit the `versions.json` file and remove the reference to the RC release in
102102
the file.
103103
- Push the changes via a PR to the ACA-Py `gh-pages` branch (don't PR them into

PUBLISHING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ a major, minor or patch release, per [semver](https://semver.org/) rules.
66

77
Once ready to do a release, create a local branch that includes the following updates:
88

9-
1. Create a local PR branch from an updated `main` branch, e.g. "1.2.1".
9+
1. Create a local PR branch from an updated `main` branch, e.g. "1.3.0rc0".
1010

1111
2. See if there are any Document Site `mkdocs` changes needed. Run the script
1212
`./scripts/prepmkdocs.sh; mkdocs`. Watch the log, noting particularly if
@@ -140,7 +140,7 @@ Once you have the list of PRs:
140140
[publish-indy.yml]: https://github.com/openwallet-foundation/acapy/blob/main/.github/workflows/publish-indy.yml
141141

142142
12. When a new release is tagged, create a new branch at the same commit with
143-
the branch name in the format `docs-v<version>`, for example, `docs-v1.2.1`.
143+
the branch name in the format `docs-v<version>`, for example, `docs-v1.3.0rc0`.
144144
The creation of the branch triggers the execution of the [publish-docs]
145145
GitHub Action which generates the documentation for the new release,
146146
publishing it at [https://aca-py.org]. The GitHub Action also executes when

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ the [LTS strategy](./LTS-Strategy.md).
5151

5252
Current LTS releases:
5353

54-
- Release [1.2](https://github.com/openwallet-foundation/acapy/releases/tag/1.2.1) **Current LTS Release**
55-
- Release [0.12](https://github.com/openwallet-foundation/acapy/releases/tag/0.12.3) **End of Life: October 2025**
54+
- Release [1.2](https://github.com/openwallet-foundation/acapy/releases/tag/1.2.4) **Current LTS Release**
55+
- Release [0.12](https://github.com/openwallet-foundation/acapy/releases/tag/0.12.6) **End of Life: October 2025**
5656

5757
Past LTS releases:
5858

docs/conf.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@
6060
"unflatten",
6161
"yaml",
6262
"uuid_utils",
63+
"did_webvh",
64+
"canonicaljson",
6365
]
6466

6567
# "acapy_agent.tests.test_conductor",
@@ -72,7 +74,7 @@
7274
# -- Project information -----------------------------------------------------
7375

7476
project = "ACA-Py"
75-
copyright = "2024, Province of British Columbia"
77+
copyright = "2025, Province of British Columbia"
7678
author = "Province of British Columbia"
7779

7880
# The short X.Y version
@@ -226,7 +228,6 @@
226228
"ACA-Py",
227229
"ACA-Py Documentation",
228230
author,
229-
"ACA-Py",
230231
"A Decentralized Trust Agent implemented in Python and\
231232
suitable for use in (almost) any non-mobile environment.",
232233
"Miscellaneous",

docs/features/SupportedRFCs.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ACA-Py or the repository `main` branch. Reminders (and PRs!) to update this page
88
welcome! If you have any questions, please contact us on the #aries channel on
99
[OpenWallet Foundation Discord](https://discord.gg/openwallet-foundation) or through an issue in this repo.
1010

11-
**Last Update**: 2025-01-21, Release 1.2.1
11+
**Last Update**: 2025-03-20, Release 1.3.0rc0
1212

1313
> The checklist version of this document was created as a joint effort
1414
> between [Northern Block](https://northernblock.io/), [Animo Solutions](https://animo.id/) and the Ontario government, on behalf of the Ontario government.
@@ -21,7 +21,7 @@ ACA-Py and other decentralized trust Frameworks and Agents.
2121

2222
| AIP Version | Supported | Notes |
2323
| - | :-------: | -------- |
24-
| AIP 1.0 | :white_check_mark: | Fully supported. Deprecation notices published|
24+
| AIP 1.0 | :white_check_mark: | Partially supported. Deprecation notices published, Connections protocol moved into an [ACA-Py Plugin](https://plugins.aca-py.org/latest/connections/)|
2525
| AIP 2.0 | :white_check_mark: | Fully supported. |
2626

2727
A summary of the Aries Interop Profiles and Aries RFCs supported in ACA-Py can be found [later in this document](#supported-rfcs).
@@ -112,22 +112,22 @@ A summary of the Aries Interop Profiles and Aries RFCs supported in ACA-Py can b
112112

113113
### AIP 1.0
114114

115-
All RFCs listed in [AIP
116-
1.0](https://github.com/hyperledger/aries-rfcs/tree/main/concepts/0302-aries-interop-profile#aries-interop-profile-version-10)
115+
Most RFCs listed in [AIP
116+
1.0](https://identity.foundation/aries-rfcs/latest/concepts/0302-aries-interop-profile/#aries-interop-profile-version-10)
117117
are fully supported in ACA-Py, but deprecation and removal of some of the
118118
protocols has begun. The following table provides notes about the implementation
119119
of specific RFCs.
120120

121121
| RFC | Supported | Notes |
122122
| --- | :--: | -- |
123123
| [0025-didcomm-transports](https://github.com/hyperledger/aries-rfcs/tree/b490ebe492985e1be9804fc0763119238b2e51ab/features/0025-didcomm-transports) | :white_check_mark: | ACA-Py currently supports HTTP and WebSockets for both inbound and outbound messaging. Transports are pluggable and an agent instance can use multiple inbound and outbound transports.|
124-
| [0160-connection-protocol](https://github.com/hyperledger/aries-rfcs/tree/9b0aaa39df7e8bd434126c4b33c097aae78d65bf/features/0160-connection-protocol) | :white_check_mark: | **DEPRECATED** In the next release, the protocol will be removed. The protocol will continue to be available as an [ACA-Py plugin], but those upgrading to that pending release and continuing to use this protocol will need to include the plugin in their deployment configuration. Users **SHOULD** upgrade to the equivalent [AIP 2.0] protocols as soon as possible. |
124+
| [0160-connection-protocol](https://github.com/hyperledger/aries-rfcs/tree/9b0aaa39df7e8bd434126c4b33c097aae78d65bf/features/0160-connection-protocol) | :x: | **MOVED TO PLUGIN** The protocol has been moved into the [ACA-Py plugin] repository. Those upgrading to Release 1.3.0 or later and continuing to use this protocol **MUST** include the [Connections plugin](https://plugins.aca-py.org/latest/connections/) in their deployment configuration. Users **SHOULD** upgrade to the equivalent [AIP 2.0] protocols as soon as possible. |
125125
| [0036-issue-credential-v1.0](https://github.com/hyperledger/aries-rfcs/tree/bb42a6c35e0d5543718fb36dd099551ab192f7b0/features/0036-issue-credential) | :white_check_mark: | **DEPRECATED** In the next release, the protocol will be removed. The protocol will continue to be available as an [ACA-Py plugin], but those upgrading to that pending release and continuing to use this protocol will need to include the plugin in their deployment configuration. Users **SHOULD** upgrade to the equivalent [AIP 2.0] protocols as soon as possible. |
126126
| [0037-present-proof-v1.0](https://github.com/hyperledger/aries-rfcs/tree/4fae574c03f9f1013db30bf2c0c676b1122f7149/features/0037-present-proof) | :white_check_mark: | **DEPRECATED** In the next release, the protocol will be removed. It will continue to be available as an [ACA-Py plugin], but those upgrading to that pending release and continuing to use this protocol will need to include the plugin in their deployment configuration. Users **SHOULD** upgrade to the equivalent [AIP 2.0] protocols as soon as possible. |
127127

128128
[ACA-Py plugin]: https://plugins.aca-py.org
129129

130-
[AIP 2.0]: https://github.com/hyperledger/aries-rfcs/tree/main/concepts/0302-aries-interop-profile#aries-interop-profile-version-20
130+
[AIP 2.0]: https://identity.foundation/aries-rfcs/latest/concepts/0302-aries-interop-profile/#aries-interop-profile-version-20
131131

132132
### AIP 2.0
133133

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ drill into the modules, subpackages and submodules that make up ACA-Py.
2929
Developers that are interested in what DIDComm protocols are supported in ACA-Py
3030
should take a look at the `protocols <generated/acapy_agent.protocols.html>`_ package.
3131
These should align with the corresponding
32-
`aries-rfcs protocols <https://github.com/hyperledger/aries-rfcs/tree/master/features>`_.
32+
`aries-rfcs protocols <https://github.com/decentralized-identity/aries-rfcs/tree/master/features>`_.
3333
Decorators defined in aries-rfcs and implemented in ACA-Py can be found
3434
`here <generated/acapy_agent.messaging.decorators.html>`_.
3535
Some general purpose subpackages that might be of interest include

0 commit comments

Comments
 (0)