Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

1.1.0 #3294

Merged
merged 1 commit into from
Oct 15, 2024
Merged

1.1.0 #3294

Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Aries Cloud Agent Python Changelog

## 1.1.0rc1
## 1.1.0

### October 15, 2024

@@ -14,11 +14,11 @@ For up to date details on what the repo move means for ACA-Py users, including s

[GitHub Issue #3250]: https://github.com/hyperledger/aries-cloudagent-python/issues/3250

### 1.1.0rc1 Deprecation Notices
### 1.1.0 Deprecation Notices

The same **[deprecation notices](#101-deprecation-notices)** from the [1.0.1](#101) release about AIP 1.0 protocols still apply. The protocols remain in the 1.1.0 release, but will be moved out of the core and into plugins soon. Please review these notifications carefully!

### 1.1.0rc1 Breaking Changes
### 1.1.0 Breaking Changes

The only (but significant) breaking changes in 1.1.0 are related to the GitHub organization and project name changes. Specific impacts are:

@@ -37,7 +37,7 @@ Anyone deploying ACA-Py should use this release to update their existing deploym

Please note that if and when the current LTS releases (0.11 and 0.12) have new releases, they will continue to use the `aries_cloudagent` source folder, the existing locations for the [PyPi] and [GHCR] container image artifacts.

#### 1.1.0rc1 Categorized List of Pull Requests
#### 1.1.0 Categorized List of Pull Requests

- Updates related to the move and rename of the repository from the Hyperledger to [OpenWallet Foundation] GitHub organization
- Change pypi upload workflow to use pypa/gh-action-pypi-publish [\#3291](https://github.com/openwallet-foundation/acapy/pull/3291) [jamshale](https://github.com/jamshale)
@@ -47,6 +47,7 @@ Please note that if and when the current LTS releases (0.11 and 0.12) have new r
- General repo updates post OWF move. [\#3267](https://github.com/openwallet-foundation/acapy/pull/3267) [jamshale](https://github.com/jamshale)

- Release management pull requests:
- 1.1.0 [\#3294](https://github.com/openwallet-foundation/acapy/pull/3292) [swcurran](https://github.com/swcurran)
- 1.1.0rc1 [\#3292](https://github.com/openwallet-foundation/acapy/pull/3292) [swcurran](https://github.com/swcurran)
- 1.1.0rc0 [\#3284](https://github.com/openwallet-foundation/acapy/pull/3284) [swcurran](https://github.com/swcurran)

4 changes: 2 additions & 2 deletions Managing-ACA-Py-Doc-Site.md
Original file line number Diff line number Diff line change
@@ -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.1.0rc1`).
- Checks out the triggering branch, either `main` or `docs-v<version>` (e.g `docs-v1.1.0`).
- 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
@@ -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.1.0rc1`
- Remove the folder for the RC. For example `rm -rf 1.1.0`
- 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
4 changes: 2 additions & 2 deletions PUBLISHING.md
Original file line number Diff line number Diff line change
@@ -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.1.0rc1".
1. Create a local PR branch from an updated `main` branch, e.g. "1.1.0".

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

1. When a new release is tagged, create a new branch at the same commit with
the branch name in the format `docs-v<version>`, for example, `docs-v1.1.0rc1`.
the branch name in the format `docs-v<version>`, for example, `docs-v1.1.0`.
The creation of the branch triggers the execution of the [publish-docs]
GitHub Action which generates the documentation for the new release,
publishing it at [https://aca-py.org]. The GitHub Action also executes when
12 changes: 7 additions & 5 deletions docs/UpdateRTD.md
Original file line number Diff line number Diff line change
@@ -14,23 +14,25 @@ and verify the installation on your system.

### Generate Module Files

To rebuild the project and settings from scratch (you'll need to move the generated index file up a level):
To rebuild the project and settings from scratch:

`rm -rf generated; sphinx-apidoc -f -M -o ./generated ../acapy_agent/ $(find ../acapy_agent/ -name '*tests*')`
``` bash
cd docs; rm -rf generated; sphinx-apidoc -f -M -o ./generated ../acapy_agent/ $(find ../acapy_agent/ -name '*tests*', cd ..)
```

Note that the `find` command that is used to exclude any of the `test` python files from the RTD documentation.

Check the `git status` in your repo to see if the generator updates, adds or removes any existing RTD modules.
Check the `git status` in your repo to see if the generator updates, adds or removes any existing RTD modules (in the `generated` folder).

### Reviewing the files locally

To auto-generate the module documentation locally run:

``` bash
sphinx-build -b html -a -E -c ./ ./ ./_build
cd docs; sphinx-build -b html -a -E -c ./ ./ ./_build; cd ..
```

Once generated, go into the `_build` folder and open `index.html` in a browser. Note that the `_build` is
Once generated, go into the `docs/_build` folder and open `index.html` in a browser. Note that the `_build` is
`.gitignore`'d and so will not be part of a git push.

### Look for Errors
4 changes: 2 additions & 2 deletions docs/features/SupportedRFCs.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Aries AIP and RFCs Supported in ACA-Py
# Aries AIP, Protocols, Credential Formats, and Aries RFCs Supported in ACA-Py

This document provides a summary of the adherence of ACA-Py to the [Aries Interop
Profiles](https://github.com/hyperledger/aries-rfcs/tree/main/concepts/0302-aries-interop-profile),
@@ -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
[OpenWallet Foundation Discord](https://discord.gg/openwallet-foundation) or through an issue in this repo.

**Last Update**: 2024-10-08, Release 1.0.1
**Last Update**: 2024-10-15, Release 1.1.0

> 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.
2 changes: 1 addition & 1 deletion open-api/openapi.json
Original file line number Diff line number Diff line change
@@ -2,7 +2,7 @@
"openapi" : "3.0.1",
"info" : {
"title" : "Aries Cloud Agent",
"version" : "v1.1.0rc1"
"version" : "v1.1.0"
},
"servers" : [ {
"url" : "/"
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.1.0rc1",
"version" : "v1.1.0",
"title" : "Aries Cloud Agent"
},
"tags" : [ {
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 = "acapy_agent"
version = "1.1.0rc1"
version = "1.1.0"
description = "(ACA-Py) A Cloud Agent Python is a foundation for building decentralized identity applications and services running in non-mobile environments. "
authors = []
license = "Apache-2.0"