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

📝 Document backwards compatibility #4457

Conversation

bisgaard-itis
Copy link
Contributor

@bisgaard-itis bisgaard-itis commented Jul 4, 2023

What do these changes do?

Add documentation for backwards compatibility of public api. Next step is to add a testing framework which can test compatible server-client versions.
See the diagram rendered here

Related issue/s

How to test

DevOps Checklist

@bisgaard-itis bisgaard-itis requested a review from pcrespov as a code owner July 4, 2023 13:48
@bisgaard-itis bisgaard-itis requested a review from elisabettai July 4, 2023 13:48
@bisgaard-itis bisgaard-itis self-assigned this Jul 4, 2023
@bisgaard-itis bisgaard-itis added the a:doc documentation, reporting, admin tasks label Jul 4, 2023
@bisgaard-itis bisgaard-itis added this to the Watermelon milestone Jul 4, 2023
@codecov
Copy link

codecov bot commented Jul 4, 2023

Codecov Report

Merging #4457 (779fcbe) into master (4ecc58b) will decrease coverage by 4.2%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##           master   #4457      +/-   ##
=========================================
- Coverage    83.8%   79.7%    -4.2%     
=========================================
  Files        1007      61     -946     
  Lines       43105    1839   -41266     
  Branches     1019       0    -1019     
=========================================
- Hits        36158    1466   -34692     
+ Misses       6726     373    -6353     
+ Partials      221       0     -221     
Flag Coverage Δ
unittests 79.7% <ø> (-4.2%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 946 files with indirect coverage changes

services/api-server/README.md Show resolved Hide resolved
@codeclimate
Copy link

codeclimate bot commented Jul 6, 2023

Code Climate has analyzed commit 779fcbe and detected 0 issues on this pull request.

View more on Code Climate.

@sonarcloud
Copy link

sonarcloud bot commented Jul 6, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@bisgaard-itis bisgaard-itis merged commit 67cda11 into ITISFoundation:master Jul 6, 2023
@bisgaard-itis bisgaard-itis deleted the document-backwards-compatibility branch July 6, 2023 13:17
@sanderegg sanderegg self-requested a review July 6, 2023 13:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a:doc documentation, reporting, admin tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants