Skip to content

update descriptions and examples #831

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

Merged
rcannood merged 1 commit into from
Jun 12, 2025
Merged

update descriptions and examples #831

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 14 additions & 4 deletions src/main/scala/io/viash/config/dependencies/Repository.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,19 @@ import java.nio.file.{Path, Paths, Files}
@description(
"""Specifies a repository where dependency components can be found.
|
| - @[local](repo_local)
| - @[git](repo_git)
| - @[github](repo_github)
| - @[vsh](repo_vsh)
| - @[local](repo_local): This package (default).
| - @[git](repo_git): A remote git repository.
| - @[github](repo_github): A remote GitHub repository.
| - @[vsh](repo_vsh): A Viash Hub package.
|""")
@exampleWithDescription(
"""repositories:
| - name: biobox
| type: vsh
| tag: 0.3.0
|""",
"yaml",
"Definition of a Viash Hub package.")
@exampleWithDescription(
"""repositories:
| - name: openpipelines-bio
Expand All @@ -40,6 +48,8 @@ import java.nio.file.{Path, Paths, Files}
"Definition of a repository in the component config or package config.")
@exampleWithDescription(
"""dependencies:
| - name: arriba
| repository: vsh://biobox@0.3.0
| - name: qc/multiqc
| repository:
| type: github
Expand Down
Loading