Skip to content

Commit

Permalink
Fix github uri -> repo, add local repository and local dependency exa… (
Browse files Browse the repository at this point in the history
#569)

* Fix github uri -> repo, add local repository and local dependency example

* Fix indentation in dependency examples
  • Loading branch information
Grifs committed Oct 13, 2023
1 parent 0e01826 commit 2d28670
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ import io.viash.exceptions.MissingBuildYamlException
"""name: qc/multiqc
|repository:
| type: github
| uri: openpipelines-bio/modules
| repo: openpipelines-bio/modules
| tag: 0.3.0
|""".stripMargin,
"yaml",
Expand All @@ -52,6 +52,12 @@ import io.viash.exceptions.MissingBuildYamlException
"yaml",
"Definition of a dependency with a repository defined as 'openpipelines-bio' under `.functionality.repositories`."
)
@exampleWithDescription(
"""name: qc/multiqc
|""".stripMargin,
"yaml",
"Definition of a local dependency. This dependency is present in the current code base and will be built when `viash ns build` is run."
)
case class Dependency(
@description("The full name of the dependency component. This should include the namespace.")
@example("name: \"my_namespace\"component", "yaml")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,14 @@ import java.nio.file.Paths
|Alternatively, this can be used to refer to a code repository present on the local hard-drive instead of fetchable remotely, for example during development.
|""".stripMargin
)
@exampleWithDescription(
"""name: my_local_code
|type: local
|path: /additional_code/src
|""".stripMargin,
"yaml",
"Refer to a local code repository under `additional_code/src` referenced to the Viash Project Config file."
)
@subclass("local")
case class LocalRepository(
name: String = "",
Expand Down

0 comments on commit 2d28670

Please sign in to comment.