From 34a440099cf2d729b7a0615d8858110337421ee4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Erik=20Jaegervall=20=28J=C3=A4gervall=29?= <30996601+erikbosch@users.noreply.github.com> Date: Tue, 3 Dec 2024 12:14:07 +0100 Subject: [PATCH] Apply suggestions from code review Co-authored-by: BjoernAtBosch --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4452d70..bee3232 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ Update `velocitas-sdk` version number in the following files: * `examples/seat-adjuster/requirements-velocitas.txt` Use the version number intended to be used for the release. -As the version has not yet been released an error in Continuous Integration for the +As the version has not yet been released, an error in Continuous Integration for the [Project creation](https://github.com/eclipse-velocitas/vehicle-app-python-sdk/actions/workflows/project-creation.yaml) workflow is expected. @@ -85,7 +85,7 @@ Running 'run'... ExecExitError: Program returned exit code: 1 ``` -It is recommended to test locally that the not yet released SDK is compatible with the Seat Adjuster example and then merge the changes +It is recommended to test locally if the not yet released SDK is compatible with the Seat Adjuster example and then merge the changes even if Continuos Integration fails. 2. Tag the commit and upload to GitHub @@ -97,12 +97,12 @@ a new version of `velocitas-lib` published in [PyPI](https://pypi.org/project/ve 3. Re-run project creation tests -Now when the updated [PyPI](https://pypi.org/project/velocitas-sdk/) package exists the [Project creation](https://github.com/eclipse-velocitas/vehicle-app-python-sdk/actions/workflows/project-creation.yaml) workflow is expected to succeed if run manually for `main`. +Now, when the updated [PyPI](https://pypi.org/project/velocitas-sdk/) package exists, the [Project creation](https://github.com/eclipse-velocitas/vehicle-app-python-sdk/actions/workflows/project-creation.yaml) workflow is expected to succeed if run manually for `main`. If not you need to troubleshoot why it doesn't. ### Updating Dependencies -This repository specify exact Python versions in `setup.py` and other files. +This repository specifies exact Python versions in `setup.py` and other files. If a version needs to be updated, for example if a vulnerability is detected, the following approach needs to be followed 1. Update version in `setup.py` if needed