-
Notifications
You must be signed in to change notification settings - Fork 56
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
Conversation
There was a problem hiding this 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. |
There was a problem hiding this comment.
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, |
There was a problem hiding this comment.
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 ----------------- |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What we could do is to mention it in:
https://github.com/COVESA/vss-tools/wiki/Release-Instructions-and-Checklist
https://github.com/COVESA/vehicle_signal_specification/wiki/Release-Instructions-and-Checklist
I.e. update it as part of release preparation.
4141518
to
8dc1c99
Compare
MoM:
|
Signed-off-by: Erik Jaegervall <erik.jaegervall@se.bosch.com>
MoM: Merge |
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.