-
Notifications
You must be signed in to change notification settings - Fork 9
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
Release candidate preparations #62
base: main
Are you sure you want to change the base?
Release candidate preparations #62
Conversation
webrtc-registration: 0.1.3-rc.1 webrtc-call-handling: 0.1.3-rc.1 webrtc-events: 0.1.0-rc.1
@stroncoso-quobis Three points on first glance:
|
Regarding release numbering: For the Spring25 release the first (pre)release will be r1.1. Regarding API versioning: a v0.1.3 would be only a patch release of the existing v0.1.1 ... are you sure that there were no breaking changes at all? (e.g. by applying the Commonality guidelines?) |
contact: | ||
email: [email protected] | ||
license: | ||
name: Apache 2.0 | ||
url: http://www.apache.org/licenses/LICENSE-2.0.html | ||
version: 0.1.3-rc.1 | ||
x-camara-commonalities: 0.4.0 | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removing trailing spaces
webrtc-registration: 0.2.0-rc.1 webrtc-call-handling: 0.2.0-rc.1 webrtc-events: 0.1.0-rc.1
ef272da
to
a35ce02
Compare
| 2 | Design guidelines from Commonalities applied | O | M | M | M | tbd | 0.5 | | ||
| 3 | Guidelines from ICM applied | O | M | M | M | tbd | 0.3.0 | | ||
| 4 | API versioning convention applied | M | M | M | M | Y | SemVer 2.0.0 | | ||
| 5 | API documentation | M | M | M | M | Y | [link](/documentation/API_documentation/webrtc-registration-API-Readiness-Checklist.md) | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The documentation should be inline in the YAML file info:description
field, so it can be rendered with Redoc or Swagger like this:
https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/WebRTC/refs/heads/main/code/API_definitions/webrtc-registration.yaml
The diagrams can be linked from Github repository (documentation folder)
As a result YAML should cover API specification and Documentation - see QoD API
| 5 | API documentation | M | M | M | M | Y | [link](/documentation/API_documentation/webrtc-registration-API-Readiness-Checklist.md) | | |
| 5 | API documentation | M | M | M | M | Y | inline in YAML| |
Initially it can be linked to API_documentation
folder https://github.com/camaraproject/WebRTC/tree/main/documentation/API_documentation
What type of PR is this?
Add one of the following kinds:
What this PR does / why we need it:
Which issue(s) this PR fixes:
Fixes #50
Fixes #51
Fixes #61
Fixes #60
Fixes #58
Special notes for reviewers:
This PR intend to solve any formality and documentation requirements to achieve public release status within the repository and APIs: webrtc-registration, webrtc-call-handling, and webrtc-events. No functionality changes are intended.
Changelog input
Additional documentation