[FOLIO-1813] When are interface versions published? Created: 18/Feb/19  Updated: 25/Jan/23  Resolved: 25/Jan/23

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: Task Priority: P3
Reporter: Marc Johnson Assignee: Unassigned
Resolution: Won't Do Votes: 0
Labels: policy, potential-decision
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Relates
relates to CIRC-196 Back end work for UICIRC-164 and UICI... Closed
Sprint: CP: Roadmap backlog
Development Team: Core: Platform

 Description   

Context

In order for a developer to understand when they should change an interface version, it is necessary to understand when an interface version is considered published (and intended to be immutable)

Given that many of our interfaces are currently defined within the same repository of the reference implementation, they are rarely updated in isolation.

Options

  • The interface is published when the reference implementation is formally released
  • The interface is published when the change is merged to the master branch of the reference implementation


 Comments   
Comment by Marc Johnson [ 18/Feb/19 ]

My understanding
It is my understanding that we agreed that interface versions were published when they were merged to master. Partly, this is due to this being when that version is published to the developer website.

This avoids confusion about a client binding to a version and then finding additional unexpected changes were included.

It does introduce the compromise that a the gap between two formally released versions may be more than a single step (e.g. 2.3 -> 2.7, and no version was formally released providing 2.4, 2.5 and 2.6 specifically).

Comment by Julian Ladisch [ 14/Feb/22 ]

Marc Johnson: You might also raise this question at https://folio-org.atlassian.net/wiki/spaces/DD

Comment by Marc Johnson [ 01/Mar/22 ]

Julian Ladisch

Thank you for your attention on this issue. I think it's rather redundant at this point and I'm tempted to close it (as I don't think it's a priority for the technical governance at the moment).

That said, you've marked it as part of the Core Platform roadmap. I don't know what that means or whether this falls within the remit of the Core Platform team.

Jakub Skoczen What do you think?

Generated at Thu Feb 08 23:16:06 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.