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

Fix github uri -> repo, add local repository and local dependency exa… #569

Merged
merged 2 commits into from
Oct 13, 2023
Merged

Fix github uri -> repo, add local repository and local dependency exa… #569

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4316943
Fix github uri -> repo, add local repository and local dependency exa…
Grifs Oct 12, 2023
da5ff71
Fix indentation in dependency examples
Grifs Oct 13, 2023
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
16 changes: 11 additions & 5 deletions src/main/scala/io/viash/functionality/dependencies/Dependency.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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")
Expand Down
8 changes: 8 additions & 0 deletions src/main/scala/io/viash/functionality/dependencies/LocalRepository.scala
View file
Open in desktop
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
Loading