Skip to content

Update VSS documentation generation to COVESA VSS 6.0 with auto-detection#76

Merged
mikehaller merged 2 commits into
mainfrom
copilot/update-vss-release-to-6-0
Mar 8, 2026
Merged

Update VSS documentation generation to COVESA VSS 6.0 with auto-detection#76
mikehaller merged 2 commits into
mainfrom
copilot/update-vss-release-to-6-0

Conversation

Copilot AI commented Mar 8, 2026

Copy link
Copy Markdown
Contributor

The VSS build script was hardcoded to VSS 3.1 and required a manual clone of the COVESA VSS repo. This updates it to auto-detect and download the latest VSS release (currently 6.0), and fixes API compatibility with vss-tools 4.2.

Build script (build-vss-docs.sh)

  • Queries GitHub API for latest release tag; falls back to v6.0 if unavailable
  • Downloads and extracts the VSS source zip automatically
  • Cleans output/ before regenerating to avoid stale files (e.g. the removed Vehicle.OBD branch)
LATEST_TAG=$(curl -s "${GITHUB_API_URL}" | python3 -c "import sys, json; print(json.load(sys.stdin)['tag_name'])" 2>/dev/null || echo "")

Python converter (vspecjson2markdown.py)

  • Replaces removed Unit class with VSSUnit/VSSUnitCollection from vss-tools 4.x API
  • Adds -q/--quantities argument; calls vspec.load_quantities() for the new quantities.yaml required by VSS 6.0
  • Sets abort_on_unknown_attribute=False to tolerate the new pattern keyword in VSS 6.0

Mako template (vss.mako.md)

  • Maps to renamed unit attributes: unit.label→unit.unit, unit.description→unit.definition, unit.domain→unit.quantity
  • Guards attribute access with hasattr checks

Regenerated output

  • 1,607 signal pages from VSS 6.0 (up from 1,138 in VSS 3.1)
  • Vehicle.OBD removed; new branches added: ControlUnit, Diagnostics, MotionManagement, Trailer, and others

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://api.github.com/repos/COVESA/vehicle_signal_specification/releases
    • Triggering command: /usr/bin/curl curl -s REDACTED (http block)
  • https://api.github.com/repos/COVESA/vehicle_signal_specification/releases/latest
    • Triggering command: /usr/bin/curl curl -s REDACTED (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

This section details on the original issue you should resolve

<issue_title>Update to latest VSS Release 6.0</issue_title>
<issue_description>Change the build script in the vss folder to retrieve the latest COVESA VSS Release automatically. Currently, that is 6.0
It would be great if the script could auto-detect the latest version.
Run the script and commit the updated static markdown files.</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

- Update build-vss-docs.sh to auto-detect latest VSS release via GitHub API
- Download and extract VSS spec automatically, clean output before regenerating
- Update vspecjson2markdown.py to use vss-tools 4.2 API (VSSUnit/VSSUnitCollection)
- Add -q/--quantities argument for quantities.yaml support
- Set abort_on_unknown_attribute=False for VSS 6.0 pattern keyword
- Update vss.mako.md template unit attribute names for new API
- Regenerate all 1607 markdown files from COVESA VSS 6.0

Co-authored-by: mikehaller <920755+mikehaller@users.noreply.github.com>
Copilot AI changed the title [WIP] Update build script to retrieve latest VSS Release 6.0 Update VSS documentation generation to COVESA VSS 6.0 with auto-detection Mar 8, 2026
@mikehaller mikehaller marked this pull request as ready for review March 8, 2026 08:06
@mikehaller mikehaller merged commit 824f3d5 into main Mar 8, 2026
1 check passed
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.

Update to latest VSS Release 6.0

2 participants