Skip to content

Commit 12ffeda

Browse files
committed
Updates to the PUBLISHING and CHANGELOG regards publishing images
Signed-off-by: Stephen Curran <swcurran@gmail.com>
1 parent 4881863 commit 12ffeda

2 files changed

Lines changed: 50 additions & 18 deletions

File tree

CHANGELOG.md

Lines changed: 36 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,50 @@ that release will be finalized. Many of the PRs in this release were previously
88
included in the `1.0.0-rc1` release. The categorized list of PRs separates those
99
that are new from those in the `1.0.0-rc1` release candidate.
1010

11-
With this release, a new automated process publishes container
12-
images in the Hyperledger container image repository for this version of ACA-Py
13-
based on both Python 3.6 and 3.9. We recommend using Python 3.9 with ACA-Py.
14-
15-
There are not a lot of new features in this release, as the focus has been on
16-
cleanup and optimization. The biggest addition is the inclusion with ACA-Py of a
17-
universal resolver interface, allowing an instance to have both local resolvers
18-
for some DID Methods and a call out to an external universal resolver for other
19-
DID Methods. Another significant new capability is full support for Hyperledger
20-
Indy transaction endorsement for Authors and Endorsers. A new repo
11+
With this release, a new automated process publishes container images in the
12+
Hyperledger container image repository. New images for the release are automatically published by the GitHubAction
13+
Workflows: [publish.yml] and [publish-indy.yml]. The actions are triggered when
14+
a release is tagged, so no manual action is needed. The images are published in
15+
the [Hyperledger Package Repository under
16+
aries-cloudagent-python](https://github.com/orgs/hyperledger/packages?repo_name=aries-cloudagent-python)
17+
and a link to the packages added to the repositories main page (under
18+
"Packages"). Additional information about the container image publication process can be
19+
found in the document [Container Images and Github Actions].
20+
21+
There are not a lot of new Aries Framework features in this release, as the
22+
focus has been on cleanup and optimization. The biggest addition is the
23+
inclusion with ACA-Py of a universal resolver interface, allowing an instance to
24+
have both local resolvers for some DID Methods and a call out to an external
25+
universal resolver for other DID Methods. Another significant new capability is
26+
full support for Hyperledger Indy transaction endorsement for Authors and
27+
Endorsers. A new repo
2128
[aries-endorser-service](https://github.com/hyperledger/aries-endorser-service)
2229
has been created that is a pre-configured instance of ACA-Py for use as an
2330
Endorser service.
2431

32+
The images are based on [Python 3.6 and 3.9 `slim-bullseye`
33+
images](https://hub.docker.com/_/python), and are built to support `linux/386
34+
(x86)`, `linux/amd64 (x64)`, and `linux/arm64`. There are two flavors of image
35+
built for each Python version. One containing the Indy/Aries Shared Libraries
36+
only ([Aries Askar](https://github.com/hyperledger/aries-askar), [Indy
37+
VDR](https://github.com/hyperledger/indy-vdr) and [Indy Shared
38+
RS](https://github.com/hyperledger/indy-shared-rs), supporting only the use of
39+
`--wallet-type askar`), and one containing the Indy/Aries shared libraries and
40+
the Indy SDK (considered deprecated). The images containing the Indy SDK are
41+
labeled `indy`. For new deployments, we recommend using the Python 3.9 Shared
42+
Library images. For existing deployments, we recommend migrating to those
43+
images. For those migrating an Indy SDK deployment, a new secure storage
44+
migration capability from Indy SDK to Aries Askar is available--contact the
45+
ACA-Py maintainers on Hyperledger Discord for details.
46+
47+
2548
## Breaking Changes
2649

2750
### PR [\#2034](https://github.com/hyperledger/aries-cloudagent-python/pull/2034) -- Implicit connections
2851

29-
The break impacts existing deployments that supported connections coming via a
30-
public DID. Such deployments need to add the configuration parameter
52+
The break impacts existing deployments that support implicit connections, those
53+
initiated by another agent using a Public DID for this instance instead of an
54+
explicit invitation. Such deployments need to add the configuration parameter
3155
`--requests-through-public-did` to continue to support that feature. The use
3256
case is that an ACA-Py instance publishes a public DID on a ledger with a
3357
DIDComm `service` in the DIDDoc. Other agents resolve that DID, and attempt to

PUBLISHING.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -107,12 +107,20 @@ Once you have the list of PRs:
107107
PRs in the release, to complement the manually curated Changelog. Verify on
108108
PyPi that the version is published.
109109

110-
9. Publish a new docker container on Docker Hub
111-
([bcgovimages/aries-cloudagent](https://hub.docker.com/r/bcgovimages/aries-cloudagent/))
112-
by following the README.md instructions to create a PR for the release in the
113-
repository
114-
[https://github.com/bcgov/aries-cloudagent-container](https://github.com/bcgov/aries-cloudagent-container).
115-
Appropriate permissions are required to publish the image.
110+
9. New images for the release are automatically published by the GitHubAction
111+
Workflows: [publish.yml] and [publish-indy.yml]. The actions are triggered
112+
when a release is tagged, so no manual action is needed. The images are
113+
published in the [Hyperledger Package Repository under
114+
aries-cloudagent-python](https://github.com/orgs/hyperledger/packages?repo_name=aries-cloudagent-python)
115+
and a link to the packages added to the repositories main page (under
116+
"Packages").
117+
118+
Additional information about the container image publication process can be
119+
found in the document [Container Images and Github Actions]().
120+
121+
[publish.yml]: https://github.com/hyperledger/aries-cloudagent-python/blob/main/.github/workflows/publish.yml
122+
[publish-indy.yml]: https://github.com/hyperledger/aries-cloudagent-python/blob/main/.github/workflows/publish-indy.yml
123+
[Container Images and Github Actions]: https://github.com/hyperledger/aries-cloudagent-python/blob/main/ContainerImagesAndGithubActions.md
116124

117125
10. Update the ACA-Py Read The Docs site by building the new "latest" (main
118126
branch) and activating and building the new release. Appropriate permissions

0 commit comments

Comments
 (0)