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.

Sign up for GitHub

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 Section about 'velocitas init' with package parameter #121

Merged
merged 2 commits into from
Apr 29, 2024
Merged

Add Section about 'velocitas init' with package parameter #121

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0087f16
Add Section about 'velocitas init' with package parameter
wba2hi Apr 29, 2024
51a4c7c
Adapt Documentation about velocitas init with packages
wba2hi Apr 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion content/en/docs/concepts/lifecycle_management/velocitas_cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Config 'src' for interface 'vehicle-signal-interface': URI or path to VSS json (

### velocitas init

Download packages configured in your `.velocitas.json` to [VELOCITAS_HOME](https://github.com/eclipse-velocitas/cli/blob/main/README.md#changing-default-velocitas_home-directory)
#### Download packages configured in your `.velocitas.json` to [VELOCITAS_HOME](https://github.com/eclipse-velocitas/cli/blob/main/README.md#changing-default-velocitas_home-directory)

```bash
vscode ➜ /workspaces/vehicle-app-python-template (main) $ velocitas init
Expand All @@ -57,6 +57,19 @@ Running 'install-deps'
...
```

#### Dynamically initialize packages NOT configured in `.velocitas.json`

Packages which are not part of `.velocitas.json` can easily be initialized using the _package parameter_ `-p / --package` and the _specifier parameter_ `-s / --specifier`. The _specifier parameter_ can be either a git tag or a git hash. If the _specifier parameter_ is omitted the latest version of the specified package will be used automatically. After initialisation the package and it's resolved version will be written to `.velocitas.json`. If the package is already part of `.velocitas.json`, however the version is different the version will be automatically adapted to reflect the specified version.
dennismeister93 marked this conversation as resolved.
Show resolved Hide resolved

```bash
vscode ➜ /workspaces/vehicle-app-python-template (main) $ velocitas init -p devenv-runtimes -s v3.0.0
Initializing Velocitas packages ...
... Package 'devenv-runtimes:v3.0.0' added to .velocitas.json
... Downloading package: 'devenv-runtimes:v3.0.0'
... > Running post init hook for ...
...
```

### velocitas sync

If any package provides files they will be synchronized into your repository.
Expand Down