search

camaraproject / HomeDevicesQoD

Repository to describe, develop, document and test the Home Devices QoD API family
Apache License 2.0
3 stars 9 forks source link

Generation of release v1.0.0 #39

Closed jpengar closed 7 months ago

jpengar commented 1 year ago

Problem description The current API version v0.2.0 will be proposed as candidate to become v1.0.0 as the first stable API release. No further functionality will be added for the time being.

However, the requirements in order to generate a release v1.0.0 in CAMARA APIs is being discussed in Commonalities #139.

API Readiness minimum criteria checklist is defined in Commonalities in: https://github.com/camaraproject/WorkingGroups/blob/main/Commonalities/documentation/API-Readiness-Checklist.md

Step 5 ("API test cases and documentation") and Step 6 ("Tested by at least 2 operators") of the checklist are the ones under discussion. Regarding Step 5, there is another issue in commonalities #61 where test cases format is being discussed as well.

Expected action

Additional context N/A

jpengar commented 1 year ago

PR to create a "home_devices_qod_readiness_checklist.md" in https://github.com/camaraproject/HomeDevicesQoD/tree/main/documentation/API_documentation with the API readiness status as done in QualityOnDemand project

https://github.com/camaraproject/HomeDevicesQoD/pull/40

jpengar commented 1 year ago

https://github.com/camaraproject/HomeDevicesQoD/issues/44 New issue to generate release v0.2.0 from the current API version v0.2.0 in main branch. In current v0.2.0 API status there is no further functionality to be added as mentioned above.

From release v0.2.0 will start the work to generate first stable API version v1.0.0 as described in this issue. Next step will be contribute with API test plan definition (".feature" gherkin file as agreed in https://github.com/camaraproject/WorkingGroups/issues/61). Step 5 of API Readiness checklist.

jpengar commented 1 year ago

From release v0.2.0 will start the work to generate first stable API version v1.0.0 as described in this issue. Next step will be contribute with API test plan definition (".feature" gherkin file as agreed in https://github.com/camaraproject/WorkingGroups/issues/61). Step 5 of API Readiness checklist.

PR https://github.com/camaraproject/HomeDevicesQoD/pull/53 contributes to the definition of the HomeDevicesQoD API test case in gherkin format (.feature file) as agreed in https://github.com/camaraproject/WorkingGroups/issues/61.

jpengar commented 10 months ago

The discussion about the minimum requirements to release a version v1.0.0 of the CAMARA API is discussed in several threads in CAMARA Commonalities and CAMARA Governance. The CAMARA TSC is discussing release management, but AFAIK this specific issue of when an API release is considered stable has not yet been resolved.

Release management issues have been consolidated into a single topic in Commonalities: https://github.com/camaraproject/ReleaseManagement/issues/9

jpengar commented 10 months ago

A specific Release Management WG has been created in CAMARA https://github.com/camaraproject/ReleaseManagement to address all these issues. This issue would mostly correspond to https://github.com/camaraproject/ReleaseManagement/issues/5

jpengar commented 7 months ago

I'll close this issue as "not planned". Issue #57 was created to adapt the API spec and API test plan to CAMARA Commonalities v0.3 and to apply other features like linting and so on. This will have to result in a new release v0.3.0 of this subproject. So I think it makes no sense to keep this issue open. We better focus on generating this new needed release. And eventually, when it is clear what the requirements are and how to release stable releases v1.0.0 in CAMARA, we can just follow whatever is defined following the same actions as other CAMARA API subprojects.