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

Public Release r1.2 for Customer Insights #24

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

PedroDiez
Copy link
Contributor

What type of PR is this?

  • documentation
  • subproject management
  • tests

What this PR does / why we need it:

PR for Public Release r1.2 for Customer Insights in MetaRelease Spring25

Which issue(s) this PR fixes:

Fixes #14

Special notes for reviewers:

Updated API ReadinessChecklist
Updated API spec (version and servers.url)
Updated Test Definitions (403 PERMISSION_DENIED wording and adding 429 TOO_MANY_REQUESTS)
Updated Changelog.md
Updated Readme.md

Changelog input

 Public Release r1.2 for Customer Insights

Additional documentation

N/A

@PedroDiez PedroDiez requested a review from rartych February 25, 2025 15:25
@PedroDiez PedroDiez self-assigned this Feb 25, 2025
@PedroDiez PedroDiez requested a review from KevScarr as a code owner February 25, 2025 15:25
@PedroDiez PedroDiez added documentation Improvements or additions to documentation subproject management Issues and PRs related to the management of the sub project labels Feb 25, 2025
@PedroDiez PedroDiez requested a review from a team February 25, 2025 15:25
Copy link

@tanjadegroot tanjadegroot left a comment

Choose a reason for hiding this comment

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

2 small updates required on the yaml file
other minor points mentioned

Choose a reason for hiding this comment

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

Line 10-14 should be replaced with the latest CHANGELOG_TEMPLATE guidelines i.e. with the following:

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

CHANGELOG.md Outdated
* N/A


**Full Changelog**: https://github.com/camaraproject/CustomerInsights/commits/r1.2

Choose a reason for hiding this comment

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

This should have the "compare" rather than the "commits" (btw the current link does not give any info ).

For the first public release, ideally it would list all commits since the creation of the API (or the "compare" with the previous pre-release - which also does not seem to give any result ?).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok, setting the compare

@@ -80,7 +80,7 @@ externalDocs:
url: https://github.com/camaraproject/CustomerInsights
x-camara-commonalities: 0.5

Choose a reason for hiding this comment

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

the x-camara-commonalities field should be part of the info object, e.g. under the version field.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@PedroDiez PedroDiez requested a review from tanjadegroot March 5, 2025 07:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation subproject management Issues and PRs related to the management of the sub project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

MetaRelease Spring 25 for Customer Insights API
2 participants