Skip to content

Commit 3d1682c

Browse files
authored
Merge pull request #3294 from swcurran/1.1.0
1.1.0
2 parents 6e2e91e + e2f463d commit 3d1682c

File tree

8 files changed

+21
-18
lines changed

8 files changed

+21
-18
lines changed

CHANGELOG.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Aries Cloud Agent Python Changelog
22

3-
## 1.1.0rc1
3+
## 1.1.0
44

55
### October 15, 2024
66

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

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

17-
### 1.1.0rc1 Deprecation Notices
17+
### 1.1.0 Deprecation Notices
1818

1919
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!
2020

21-
### 1.1.0rc1 Breaking Changes
21+
### 1.1.0 Breaking Changes
2222

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

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

3838
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.
3939

40-
#### 1.1.0rc1 Categorized List of Pull Requests
40+
#### 1.1.0 Categorized List of Pull Requests
4141

4242
- Updates related to the move and rename of the repository from the Hyperledger to [OpenWallet Foundation] GitHub organization
4343
- 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
4747
- General repo updates post OWF move. [\#3267](https://github.com/openwallet-foundation/acapy/pull/3267) [jamshale](https://github.com/jamshale)
4848

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

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.1.0rc1`).
23+
- Checks out the triggering branch, either `main` or `docs-v<version>` (e.g `docs-v1.1.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.1.0rc1`
100+
- Remove the folder for the RC. For example `rm -rf 1.1.0`
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.1.0rc1".
9+
1. Create a local PR branch from an updated `main` branch, e.g. "1.1.0".
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
1. 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.1.0rc1`.
143+
the branch name in the format `docs-v<version>`, for example, `docs-v1.1.0`.
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

docs/UpdateRTD.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,25 @@ and verify the installation on your system.
1414

1515
### Generate Module Files
1616

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

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

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

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

2527
### Reviewing the files locally
2628

2729
To auto-generate the module documentation locally run:
2830

2931
``` bash
30-
sphinx-build -b html -a -E -c ./ ./ ./_build
32+
cd docs; sphinx-build -b html -a -E -c ./ ./ ./_build; cd ..
3133
```
3234

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

3638
### Look for Errors

docs/features/SupportedRFCs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Aries AIP and RFCs Supported in ACA-Py
1+
# Aries AIP, Protocols, Credential Formats, and Aries RFCs Supported in ACA-Py
22

33
This document provides a summary of the adherence of ACA-Py to the [Aries Interop
44
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
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**: 2024-10-08, Release 1.0.1
11+
**Last Update**: 2024-10-15, Release 1.1.0
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.

open-api/openapi.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"openapi" : "3.0.1",
33
"info" : {
44
"title" : "Aries Cloud Agent",
5-
"version" : "v1.1.0rc1"
5+
"version" : "v1.1.0"
66
},
77
"servers" : [ {
88
"url" : "/"

open-api/swagger.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"swagger" : "2.0",
33
"info" : {
4-
"version" : "v1.1.0rc1",
4+
"version" : "v1.1.0",
55
"title" : "Aries Cloud Agent"
66
},
77
"tags" : [ {

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "acapy_agent"
3-
version = "1.1.0rc1"
3+
version = "1.1.0"
44
description = "(ACA-Py) A Cloud Agent Python is a foundation for building decentralized identity applications and services running in non-mobile environments. "
55
authors = []
66
license = "Apache-2.0"

0 commit comments

Comments
 (0)