Skip to content

Pre-release r1.1 for Fall25 m3 milestone#25

Merged
jpengar merged 12 commits intomainfrom
jpengar/release-r3.1
Jul 11, 2025
Merged

Pre-release r1.1 for Fall25 m3 milestone#25
jpengar merged 12 commits intomainfrom
jpengar/release-r3.1

Conversation

@jpengar
Copy link
Contributor

@jpengar jpengar commented Jun 24, 2025

What type of PR is this?

  • repository management

What this PR does / why we need it:

  • creates the API readiness checklist
  • creates and adds section for r1.1 to the changelog
  • update README.md
  • PENDING updates the versions and server URLs in API and test definition files -> UPDATE (08/07): done.
  • PENDING updates the API spec according to CAMARA ICM r3.2 and CAMARA Commonalities r3.2. -> UPDATE (08/07): done.
  • PENDING adds basic test definitions (NOTE: This may need to wait until public release) -> UPDATE (30/06): I have created issue API Test Definitions for Fall25 #29 to include API test definitions, as well as PR API test definitions #30 to address this. -> UPDATE (08/07): Test definitions are ready.

Which issue(s) this PR fixes:

Fixes #24

Special notes for reviewers:

The PR is set to 'DRAFT' for the time being, until PRs #20 and #22 have been resolved. CC @subha5h. This is also a dependency for test definitions (#29 & #30). -> UPDATE (08/07): Considering the time restrictions we are currently facing to generate the first API pre-release on time (M3 milestone). We leave #20 out of the first pre-release, but we will review and polish it definitively before the final public release. #22 is merged.

Changelog input

 Pre-release r1.1 for Fall25 m3 milestone

Additional documentation

N/A

@jpengar jpengar added the fall25 label Jun 24, 2025
@github-actions
Copy link

github-actions bot commented Jun 24, 2025

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ ACTION actionlint 2 0 0.03s
✅ OPENAPI spectral 1 0 1.59s
✅ REPOSITORY git_diff yes no 0.0s
✅ REPOSITORY secretlint yes no 0.68s
✅ YAML yamllint 1 0 0.38s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by OX Security

@hdamker
Copy link
Contributor

hdamker commented Jun 29, 2025

  • PENDING adds basic test definitions (NOTE: This may need to wait until public release)

Please try to add them still as soon as possible ... if possible before the creation of the release candidate. They are mandatory to give implementations of the rc some test cases at hand.

@hdamker
Copy link
Contributor

hdamker commented Jun 29, 2025

@jpengar Just seen now: why r3.1? It's the very first release in this repository, so you should start with r1.1

@jpengar
Copy link
Contributor Author

jpengar commented Jun 30, 2025

  • PENDING adds basic test definitions (NOTE: This may need to wait until public release)

Please try to add them still as soon as possible ... if possible before the creation of the release candidate. They are mandatory to give implementations of the rc some test cases at hand.

I would love to, but first we need to finalise the API design, particularly the content of the API response, in order to properly define the test scenarios 😕

@jpengar
Copy link
Contributor Author

jpengar commented Jun 30, 2025

@jpengar Just seen now: why r3.1? It's the very first release in this repository, so you should start with r1.1

My bad. I'll fix it.

@jpengar jpengar changed the title Pre-release r3.1 for Fall25 m3 milestone Pre-release r1.1 for Fall25 m3 milestone Jun 30, 2025
@jpengar
Copy link
Contributor Author

jpengar commented Jun 30, 2025

@hdamker

@jpengar Just seen now: why r3.1? It's the very first release in this repository, so you should start with r1.1

Fixed in 9c87002

Please try to add them still as soon as possible ... if possible before the creation of the release candidate. They are mandatory to give implementations of the rc some test cases at hand.

I've added the API Test Cases in 5bef1f7 but I will better move it to another independent PR just in case.

This was referenced Jun 30, 2025
@jpengar jpengar mentioned this pull request Jul 8, 2025
@jpengar jpengar marked this pull request as ready for review July 8, 2025 11:11
@jpengar jpengar requested review from a team, AxelNennker and sebdewet as code owners July 8, 2025 11:11
Copy link

@diegogonmar diegogonmar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@hdamker
Copy link
Contributor

hdamker commented Jul 8, 2025

@jpengar Great that this PR is ready for review!

A few minor and easy to fix issues found in the API and test definition files:


The externalDocs object is missing
Add:

externalDocs:
  description: Product documentation at CAMARA
  url: https://github.com/camaraproject/ConsentInfo

Location: info.version
Issue: Version is "v0.1.0-rc.1" but should not have "v" prefix
Fix: Change to "0.1.0-rc.1"


Location: components.responses.Generic401
Issue: Message lacks "A new authentication is required" as required by Commonalities 0.6
Current: "Request not authenticated due to missing, invalid, or expired credentials."
Fix: Update to: "Request not authenticated due to missing, invalid, or expired credentials. A new authentication is required."


Location: Test file name
Issue: File named consent-info-verifyStatus.feature but operation is retrieveStatus
Fix: Rename to either:

consent-info.feature (recommended for single operation API)
consent-info-retrieveStatus.feature (if following operation-specific naming)


Info Object - Title should not include 'API': Consent Info API

Copy link
Contributor

@hdamker hdamker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And the minor points within the remaining files

@jpengar
Copy link
Contributor Author

jpengar commented Jul 9, 2025

@jpengar Great that this PR is ready for review!

A few minor and easy to fix issues found in the API and test definition files:

@hdamker "Haste makes waste." 😓. Thank you for the detailed review. Hopefully, I have addressed all your comments and suggestions in 1987f9c

@hdamker
Copy link
Contributor

hdamker commented Jul 9, 2025

Hopefully, I have addressed all your comments and suggestions in 1987f9c

@jpengar looks good on first glance, I will come back later for a final review. At least our robot is now happy (but has only partial coverage):

🔴 Critical: 0
🟡 Medium: 0
🔵 Low: 0

@jpengar
Copy link
Contributor Author

jpengar commented Jul 10, 2025

@hdamker I'm afraid I'll be out of office next week. I apologise for bothering you, as I know you're very busy at the moment. Do you think we could finalise the review of this PR to generate the release before I leave? I just want to avoid any problems as I am the PR owner.

@hdamker
Copy link
Contributor

hdamker commented Jul 10, 2025

@hdamker I'm afraid I'll be out of office next week. I apologise for bothering you, as I know you're very busy at the moment. Do you think we could finalise the review of this PR to generate the release before I leave? I just want to avoid any problems as I am the PR owner.

I don't think that there will be further comments from me and ReleaseManagement side. So if there are the approvals from the other codeowners they can also merge it.

Copy link
Contributor

@hdamker hdamker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM from ReleaseManagement perspective.

@jpengar
Copy link
Contributor Author

jpengar commented Jul 10, 2025

@hdamker I'm afraid I'll be out of office next week. I apologise for bothering you, as I know you're very busy at the moment. Do you think we could finalise the review of this PR to generate the release before I leave? I just want to avoid any problems as I am the PR owner.

I don't think that there will be further comments from me and ReleaseManagement side. So if there are the approvals from the other codeowners they can also merge it.

Could you please review this, @sebdewet or @AxelNennker, so I can merge it and create the pre-release?

Copy link

@sebdewet sebdewet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jpengar jpengar merged commit 6f34d7d into main Jul 11, 2025
2 checks passed
@jpengar jpengar deleted the jpengar/release-r3.1 branch July 21, 2025 09:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create release PR for Fall25 M3

4 participants