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

Release candidate preparations #62

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

Conversation

stroncoso-quobis
Copy link
Collaborator

What type of PR is this?

Add one of the following kinds:

  • documentation
  • subproject management

What this PR does / why we need it:

  • Release process to create first public release candidate for WebRTC APIs

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

Version URL path to rc.1
- webrtc-registration: 0.1.3-rc.1
- webrtc-call-handling: 0.1.3-rc.1
- webrtc-events: 0.1.0-rc.1

Additional documentation

API readiness checklist for webrtc-registration
API readiness checklist for webrtc-call-handling
API readiness checklist for webrtc-events

webrtc-registration: 0.1.3-rc.1
webrtc-call-handling: 0.1.3-rc.1
webrtc-events: 0.1.0-rc.1
@hdamker
Copy link
Contributor

hdamker commented Jan 19, 2025

@stroncoso-quobis Three points on first glance:

  • The Readiness Checklists should reflect the status of the planned release ... currently the status columns are empty
  • A rc version of the APIs requires at least the basic test case definition, without them an alpha release is possible (see mandatory "Basic API test cases & documentation" in the Checklist).
  • For Spring25 the Commonalities version is 0.5, not 0.4.0
  • CHANGELOG and README.md should be added before ReleaseManagement review

@hdamker
Copy link
Contributor

hdamker commented Jan 19, 2025

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?)
One change would be for example that the URL for a CAMARA 0.x.y API should be .../v0.x, not /v0 (to be able to distinct it from a further 0.x+1.y version) also from client side.
My recommendation would be to go to 0.2.0 for the Spring25 release cycle.

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

Copy link
Collaborator

Choose a reason for hiding this comment

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

Removing trailing spaces

Suggested change

webrtc-registration: 0.2.0-rc.1
webrtc-call-handling: 0.2.0-rc.1
webrtc-events: 0.1.0-rc.1
@stroncoso-quobis stroncoso-quobis force-pushed the spring25-release-candidate branch from ef272da to a35ce02 Compare January 24, 2025 12:32
| 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) |
Copy link
Collaborator

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

Suggested change
| 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants