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

Add compatibility test #337

Merged
merged 1 commit into from
Apr 12, 2024
Merged

Add compatibility test #337

merged 1 commit into from
Apr 12, 2024

Conversation

erikbosch
Copy link
Collaborator

This intends to make us more conscious on if we break backward compatibility, so that we can take a deliberate decision if that is OK and possibly could document it as well.

Copy link
Collaborator

@ppb2020 ppb2020 left a comment

Choose a reason for hiding this comment

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

A few simple notes.

README.md Outdated
@@ -42,6 +42,30 @@ Examples on tool usage can be found in the [VSS Makefile](https://github.com/COV

All current tools are based on common Python functionality in the `vspec` folder to read, parse and expand a Vehicle Signal Specification files(*.vspec files). As an example, if the standard [VSS root file](https://github.com/COVESA/vehicle_signal_specification/blob/master/spec/VehicleSignalSpecification.vspec) is given as input then the Python tooling will read all included files, do a validation of the content, expand any instances used and create an in-memory representation which then can be used by specialized tools to generate the wanted output.

## Compatibility with VSS

The [COVESA VSS project repository](https://github.com/COVESA/vehicle_signal_specification) include vss-tools as a submodule.
Copy link
Collaborator

Choose a reason for hiding this comment

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

include -> includes

README.md Outdated
## Compatibility with VSS

The [COVESA VSS project repository](https://github.com/COVESA/vehicle_signal_specification) include vss-tools as a submodule.
The vss-tools version linked by the VSS repository is the preferred vss-tools version to use for that particular version of the VSS repository. It is not guaranteed that newer or older versions of vss-tools successfully can handle that particular version of the VSS repository. The table below gives an overview of basic version support,
Copy link
Collaborator

Choose a reason for hiding this comment

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

successfully can -> can successfully

#
# Intended workflow:
#
# ---------- After a new VSS release -----------------
Copy link
Collaborator

Choose a reason for hiding this comment

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

How do we remember to come update this for every release?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@erikbosch erikbosch force-pushed the erik_compat branch 2 times, most recently from 4141518 to 8dc1c99 Compare March 27, 2024 13:32
@erikbosch erikbosch marked this pull request as ready for review March 27, 2024 13:35
@erikbosch
Copy link
Collaborator Author

erikbosch commented Apr 2, 2024

MoM:

  • Please review
  • Ulf: mention that testis on JSON
  • Erik: Possible merge decision next week

Signed-off-by: Erik Jaegervall <erik.jaegervall@se.bosch.com>
@erikbosch
Copy link
Collaborator Author

MoM: Merge

@erikbosch erikbosch merged commit da1d6ad into COVESA:master Apr 12, 2024
5 checks passed
@erikbosch erikbosch deleted the erik_compat branch April 12, 2024 11:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants