Skip to content

Commit 651a223

Browse files
committed
docs(readme): update MCAP format status and release process
- Remove outdated warning about MCAP being a draft specification - Reference OSI v3.8.0-rc1 where MCAP multi-channel trace format is official - Update ASAM OSI Utilities link (remove hardcoded path to example) - Document new workflow_dispatch release trigger alongside tag-push Signed-off-by: jdsika <carlo.van-driesten@bmw.de>
1 parent 31c7a8c commit 651a223

1 file changed

Lines changed: 12 additions & 19 deletions

File tree

README.md

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@
44

55
A converter extension which visualizes data following the standard of the [ASAM Open Simulation Interface (ASAM OSI)](https://www.asam.net/standards/detail/osi/) using the native 3D panel of Lichtblick.
66

7-
:warning: **Current version not compliant with official ASAM OSI**:
8-
9-
Current ASAM OSI [tracefile formats](https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/interface/architecture/trace_file_formats.html) do not yet include the draft for the MCAP Multitrace Format. This will be officially completed in this [OpenX Project Proposal](https://code.asam.net/simulation/openx/-/issues/17). You can use the [ASAM OSI Utilities](https://github.com/Lichtblick-Suite/asam-osi-utilities/blob/main/examples/convert_osi2mcap.cpp) to create OSI MCAP traces according to the current [specification draft](https://github.com/OpenSimulationInterface/open-simulation-interface/pull/841).
7+
This extension reads OSI messages from [MCAP trace files](https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/interface/architecture/trace_file_formats.html) — the multi-channel trace format officially specified since [OSI v3.8.0-rc1](https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.8.0-rc1). You can create compliant MCAP traces using the [ASAM OSI Utilities](https://github.com/Lichtblick-Suite/asam-osi-utilities).
108

119
## Getting started
1210

@@ -113,31 +111,26 @@ Since this project relies on older but stable build tooling, prefer minor/patch
113111

114112
## **3. Release Process**
115113

116-
The release workflow is triggered when a push of a tag (`v[0-9].[0-9]+.[0-9]+`) occurs.
117-
The release workflow creates a changelog, builds the foxe extension based on the version specified in `package.json` and finally creates a release on github with the corresponding artifacts.
118-
119-
Make sure to bump the version number in `package.json` and commit and push before tagging.
120-
121-
### Steps to Tag a Release
114+
The release workflow is triggered in one of two ways:
122115

123-
1. Ensure all changes for the release are committed and pushed to the main branch.
124-
2. Use the following command to create a new tag:
116+
1. **Push a signed tag:**
125117

126118
```bash
127119
git tag -s -a v<version> -m "Release v<version>"
120+
git push origin v<version>
128121
```
129122

130-
Example:
123+
2. **Manual trigger:** Go to **Actions → release → Run workflow** and type the version from `package.json` (e.g. `0.2.0`) to confirm.
131124

132-
```bash
133-
git tag -s -a v1.0.0 -m "ASAM OSI Converter v1.0.0"
134-
```
125+
Both paths read the version from `package.json` as the single source of truth. The tag-push path validates that the pushed tag matches `package.json`. The manual path validates the tag does not already exist and creates it automatically.
135126

136-
3. Push the tag to the remote repository:
127+
The workflow generates a changelog, builds the `.foxe` extension, runs a ScanCode license scan, and creates a GitHub Release with all artifacts.
137128

138-
```bash
139-
git push origin v<version>
140-
```
129+
### Steps
130+
131+
1. Ensure all changes for the release are committed and pushed to the main branch.
132+
2. Bump the version in `package.json`, commit and push.
133+
3. Either push a signed tag or use the manual trigger in GitHub Actions.
141134

142135
---
143136

0 commit comments

Comments
 (0)