Skip to content

Commit

Permalink
Merge pull request #103 from viash-io/fix/scope_documentation
Browse files Browse the repository at this point in the history
Improve scope page with future version
  • Loading branch information
Grifs authored Jan 16, 2025
2 parents d966025 + 4a112dd commit 7cbc89a
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions reference/config/scope.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,27 @@ search: true
---

Defines the scope of the component.
`test`: only available during testing; components aren't published.
`private`: only meant for internal use within a workflow or other component.
`public`: core component or workflow meant for general use.

- `test`: only available during testing; components aren't published
- `private`: only meant for internal use within a workflow or other component
- `public`: core component or workflow meant for general use

## image

**Type**: `ScopeEnum`

test: image is only used during testing and is transient
private: image is published in the registry
public: image is published in the registry
Defines whether the image is published or not.

- `test`: image is only used during testing and is transient
- `private`: image is published in the registry
- `public`: image is published in the registry

## target

**Type**: `ScopeEnum`

test: target folder is only used during testing and is transient
private: target folder can be published in target/private or target/dependencies/private
public: target is published in target/executable or target/nextflow
Defines the target location of the component.

- `test`: target folder is only used during testing and is transient
- `private`: target folder can be published in target/_private or target/dependencies/_private
- `public`: target is published in target/executable or target/nextflow

0 comments on commit 7cbc89a

Please sign in to comment.