diff --git a/src/main/scala/io/viash/functionality/dependencies/Dependency.scala b/src/main/scala/io/viash/functionality/dependencies/Dependency.scala index 0e471af1b..136deba39 100644 --- a/src/main/scala/io/viash/functionality/dependencies/Dependency.scala +++ b/src/main/scala/io/viash/functionality/dependencies/Dependency.scala @@ -30,10 +30,10 @@ import io.viash.exceptions.MissingBuildYamlException |""".stripMargin) @exampleWithDescription( """name: qc/multiqc - | repository: - | type: github - | uri: openpipelines-bio/modules - | tag: 0.3.0 + |repository: + | type: github + | repo: openpipelines-bio/modules + | tag: 0.3.0 |""".stripMargin, "yaml", "Definition of dependency with a fully defined repository" @@ -47,11 +47,17 @@ import io.viash.exceptions.MissingBuildYamlException ) @exampleWithDescription( """name: qc/multiqc - | repository: "openpipelines-bio" + |repository: "openpipelines-bio" |""".stripMargin, "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") diff --git a/src/main/scala/io/viash/functionality/dependencies/LocalRepository.scala b/src/main/scala/io/viash/functionality/dependencies/LocalRepository.scala index 69472d470..c90d10fbc 100644 --- a/src/main/scala/io/viash/functionality/dependencies/LocalRepository.scala +++ b/src/main/scala/io/viash/functionality/dependencies/LocalRepository.scala @@ -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 = "",