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

Version within CAMARA_common.yaml shouldn't be "wip" #254

Closed
hdamker opened this issue Jul 19, 2024 · 3 comments · Fixed by rartych/Commonalities#9 or #257
Closed

Version within CAMARA_common.yaml shouldn't be "wip" #254

hdamker opened this issue Jul 19, 2024 · 3 comments · Fixed by rartych/Commonalities#9 or #257
Labels
correction correction in documentation

Comments

@hdamker
Copy link
Collaborator

hdamker commented Jul 19, 2024

Problem description

Within rc.1 the version in

version: 0.4.0-wip
is "0.4.0-wip".

Expected behavior

A non "wip" version should be set, and referred within the release description/changelog of rc.2

Alternative solution

Additional context

@hdamker hdamker added the correction correction in documentation label Jul 19, 2024
@rartych
Copy link
Collaborator

rartych commented Jul 22, 2024

The whole info object in CAMARA_common.yaml need to be aligned with the changes introduced in API Design Guidelines.
https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#info-object

The problem we have with version field is that in Commonalities v.0.3.0 it was set to 0.4.0.
https://github.com/camaraproject/Commonalities/blob/release-0.3.0/artifacts/CAMARA_common.yaml#L10

As CAMARA_common.yaml is not to be implemented, not increasing the version this time would not be very harmful.
Then we would get :

info:
  title: Camara common data types
  description: Common data types for Camara APIs
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 0.4.0
  x-camara-commonalities: 0.4.0

Increasing version field (it is mandatory in OAS):

  version: 0.5.0
  x-camara-commonalities: 0.4.0

looks confusing for me.

@hdamker
Copy link
Collaborator Author

hdamker commented Jul 22, 2024

As we introduced for APIs that the release numbering is independent from the (API) versioning, I personally wouldn't be confused if Commonalities would have artefacts which are diverging from the release number. In fact I would even expect the artefacts have their independent version numbers.

@rartych
Copy link
Collaborator

rartych commented Jul 22, 2024

As it was discussed in Commonalities meeting decoupling of CAMARA_common.yaml version from Commonalities version allows to introduce changes even faster than Commonalities versions are released.
Changes will be introduced in #257 .

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