Release r1.1 (Release Candidate) #71

PedroDiez · 2025-01-15T16:38:09Z

What type of PR is this?

documentation
subproject management

What this PR does / why we need it:

Blockchain Public Address Release r1.1 (Release Candidate) PR (Spring25)

Which issue(s) this PR fixes:

Fixes #66
Fixes #63
Fixes #65
Fixes #64

Special notes for reviewers:

The following PRs MUST be merged prior to this one:

Update User Stories filename in #67
API Spec aligment with Commonalities and ICM in #69
Basic Test cases definition in #70
Generate API Readiness Checklist in #68

Changelog input

Release r1.1 (Release Candidate) for Blockchain Public Address API

Additional documentation

This section can be blank.

docs

hdamker · 2025-01-15T19:04:50Z

Hi @PedroDiez thanks for creating the release PR. I've created for the review camaraproject/ReleaseManagement#138, but seems we need to wait until the open PRs are merged.

The release PR

touches also the YAML file(s), checklist, test definitions and set the right version numbers in all files
the checklist could have been part of the release PR, as it describes the status of the repository at time of the release. A separate PR isn't necessary for that

Minor point:

https://github.com/camaraproject/BlockchainPublicAddress/blob/main/code/API_definitions/README.MD should be deleted

PedroDiez · 2025-01-16T08:34:02Z

Hi @hdamker,

Thanks for the comments.

Understood about API Readiness Checklist (will do in that way in the next releases)
Have also addressed the README.md removal

tanjadegroot

this PR needs updates, and the other PRs should be merged before this on. this should be the last PR to merge.

tanjadegroot · 2025-01-28T23:44:15Z

CHANGELOG.md

@@ -2,12 +2,70 @@

 ## Table of Contents

+- [r2.1 - rc](#r11---rc)


change #r11 to #r21
the "---rc" is optional and is not to be used in the actual release tag

@tanjadegroot could it be that the only mistake regarding the release number is in this line? That it should be:

Suggested change

- [r2.1 - rc](#r11---rc)

- [r1.1 - rc](#r11---rc)

It's the first participations of the API Repository in a meta-release, as @PedroDiez in my view rightfully commented. Than r1.1 should be ok across the other files. Just here in the table of content it was wrong.

Ok, I will review is r1.1 across all documentation

If indeed this is the first release and the v0.1.0 in the CHANGELOG is the same, then the V0.1.0 should be replaced by r1.1 indeed. However, there was already an (alpha) release v0.1.0 pre-released before and a tag was created. This is a first pre-release version of a new target v0.2.0 (v0.2.0-rc.1) API, logically it should be called r2.1.

But if you have done all the changes already to r1.1, then go with r1.1 - fine for me

ok, I keep r1.1

tanjadegroot · 2025-01-28T23:47:15Z

CHANGELOG.md

 - [v0.1.0](#v010)

 **Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until it has been released. For example, changes may be reverted before a release is published. For the best results, use the latest published release.**

+The below sections record the changes for each API version in each release as follows:


Change lines 10-14 by the latest version (from ReleaseManagement/documentation/CHANGELOG_TEMPLATE.md):

The below sections record the changes for each API version in each release as follows:

for an alpha release, the delta with respect to the previous release

for the first release-candidate, all changes since the last public release

for subsequent release-candidate(s), only the delta to the previous release-candidate

for a public release, the consolidated changes since the previous public release

tanjadegroot · 2025-01-28T23:47:37Z

CHANGELOG.md

+* for subsequent alpha or release-candidate API versions, the delta with respect to the previous pre-release
+* for a public API version, the consolidated changes since the release of the previous public API version
+
+## r1.1 - rc


@tanjadegroot this API has never had a former release within "Metarelease" tracks.
Even so we should use r2.1 as r1.x was the one used within MetaRelease Fall24? Just to double check as i am involved in other API with the same scenario

sorry for the delay in answering. the release numbering (1.x, 2.x, etc) is not linked to the meta-release.
it is used for tracking progress/history of the API development and publication, but for pre-releases and public release. Release number increase with each new target release (be it in a meta-release or not), so I think it should be r2.1 as you changed from a 0.1.0 target to a 0.2.0 target which normally would have different release trackers.

But as said above, if you have already updated the files to use r1.1, it is fine with me.

tanjadegroot · 2025-01-28T23:48:55Z

CHANGELOG.md

+
+The API definition(s) are based on
+* Commonalities v0.5.0-rc.1
+* Identity and Consent Management v0.3.0-alpha.1


use v0.3.0-rc.1 (release PR)

CHANGELOG.md

tanjadegroot · 2025-01-29T00:16:02Z

README.md

+* **The Release [r1.1 - rc](https://github.com/camaraproject/BlockchainPublicAddress/blob/main/CHANGELOG.md#r1.1---rc) for the Blockchain Public Address APIs Family is available.**
+<br>This is a release candidate. Until the public release there are bug fixes to be expected. The release candidate is suitable for implementors, but it is not recommended to use the API with customers in productive environments.
+
+* The release **r1.1 - rc** is available in [r1.1](https://github.com/camaraproject/BlockchainPublicAddress/tree/r2.1), and includes the following APIs:
 * API definition of Blockchain Public Address API is 0.1.0 (with inline documentation):


0.1.0 --> 0.2.0-rc.1

README.md

tanjadegroot · 2025-01-29T00:18:38Z

README.md

+  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/BlockchainPublicAddress/r1.1/code/API_definitions/blockchain-public-address.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/BlockchainPublicAddress/blob/r1.1/code/API_definitions/blockchain-public-address.yaml)
+
+* Other releases of this sub project are available in [BlockchainPublicAddress Releases](https://github.com/camaraproject/BlockchainPublicAddress/releases)
 * For changes see [CHANGELOG.md](https://github.com/camaraproject/BlockchainPublicAddress/blob/main/CHANGELOG.md)


use here a local URL reference: CHANGELOG.md

tanjadegroot · 2025-01-29T01:52:44Z

Some updates needed and PRs still to be merged before the release PR can be merged.
gettting there :-)

PedroDiez · 2025-01-30T17:06:49Z

I will wait to make updates until merge of PRs

So i can also address some minor points (e.g. version and servers.url adaptation)

tanjadegroot · 2025-02-12T18:38:51Z

I will wait to make updates until merge of PRs

API Spec Alignment with Commonalities and ICM - Release 1.1 #69

API readiness checklist update for r1.1 #68

So i can also address some minor points (e.g. version and servers.url adaptation)

Please try to have that done this week.

PedroDiez · 2025-02-13T19:09:16Z

I will wait to make updates until merge of PRs

API Spec Alignment with Commonalities and ICM - Release 1.1 #69

API readiness checklist update for r1.1 #68

So i can also address some minor points (e.g. version and servers.url adaptation)

Please try to have that done this week.

Have manage comments. Waiting to merge #69 first and align branch

Release r1.1 (Release Candidate)

83cf3cd

PedroDiez requested review from grgpapadopoulos and ksl4dtit as code owners January 15, 2025 16:38

PedroDiez self-assigned this Jan 15, 2025

PedroDiez added documentation Improvements or additions to documentation subproject management Indicating issues with subproject repository or release management process labels Jan 15, 2025

PedroDiez requested review from rartych and a team January 15, 2025 16:38

hdamker mentioned this pull request Jan 15, 2025

BlockchainPublicAddress r1.1 (Spring25 M3) release review camaraproject/ReleaseManagement#138

Open

11 tasks

remove_README.md_from_API_definitions

8166865

grgpapadopoulos previously approved these changes Jan 16, 2025

View reviewed changes

alignment_with_commonalities_r2.2

a49c8c5

PedroDiez dismissed grgpapadopoulos’s stale review via a49c8c5 January 24, 2025 15:53

PedroDiez requested a review from grgpapadopoulos January 24, 2025 15:59

tanjadegroot suggested changes Jan 29, 2025

View reviewed changes

grgpapadopoulos previously approved these changes Jan 29, 2025

View reviewed changes

This was referenced Jan 30, 2025

API Spec Alignment with Commonalities and ICM - Release 1.1 #69

Open

API readiness checklist update for r1.1 #68

Merged

updates_after_RM_review

0bb7f2a

PedroDiez dismissed grgpapadopoulos’s stale review via 0bb7f2a February 13, 2025 19:08

PedroDiez requested a review from grgpapadopoulos February 13, 2025 19:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Release r1.1 (Release Candidate) #71

Release r1.1 (Release Candidate) #71

PedroDiez commented Jan 15, 2025

hdamker commented Jan 15, 2025

PedroDiez commented Jan 16, 2025

tanjadegroot left a comment

tanjadegroot Jan 28, 2025 •

edited

Loading

hdamker Jan 29, 2025 •

edited

Loading

PedroDiez Jan 30, 2025

tanjadegroot Feb 7, 2025 •

edited

Loading

tanjadegroot Feb 7, 2025

PedroDiez Feb 13, 2025

tanjadegroot Jan 28, 2025

PedroDiez Feb 13, 2025 •

edited

Loading

tanjadegroot Jan 28, 2025

PedroDiez Jan 29, 2025

tanjadegroot Feb 7, 2025

tanjadegroot Jan 28, 2025

PedroDiez Feb 13, 2025 •

edited

Loading

tanjadegroot Jan 29, 2025

PedroDiez Feb 13, 2025

tanjadegroot Jan 29, 2025

PedroDiez Feb 13, 2025

tanjadegroot commented Jan 29, 2025 •

edited

Loading

PedroDiez commented Jan 30, 2025

tanjadegroot commented Feb 12, 2025

PedroDiez commented Feb 13, 2025

		@@ -2,12 +2,70 @@

		## Table of Contents

		- [r2.1 - rc](#r11---rc)

Release r1.1 (Release Candidate) #71

Are you sure you want to change the base?

Release r1.1 (Release Candidate) #71

Conversation

PedroDiez commented Jan 15, 2025

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for reviewers:

Changelog input

Additional documentation

hdamker commented Jan 15, 2025

PedroDiez commented Jan 16, 2025

tanjadegroot left a comment

Choose a reason for hiding this comment

tanjadegroot Jan 28, 2025 • edited Loading

Choose a reason for hiding this comment

hdamker Jan 29, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tanjadegroot Feb 7, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PedroDiez Feb 13, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PedroDiez Feb 13, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tanjadegroot commented Jan 29, 2025 • edited Loading

PedroDiez commented Jan 30, 2025

tanjadegroot commented Feb 12, 2025

PedroDiez commented Feb 13, 2025

tanjadegroot Jan 28, 2025 •

edited

Loading

hdamker Jan 29, 2025 •

edited

Loading

tanjadegroot Feb 7, 2025 •

edited

Loading

PedroDiez Feb 13, 2025 •

edited

Loading

PedroDiez Feb 13, 2025 •

edited

Loading

tanjadegroot commented Jan 29, 2025 •

edited

Loading