grim/convey

Add documentation for the podman tasks
redux
2021-10-16, Gary Kramlich
fd65c6d6f2ab
Add documentation for the podman tasks
# Intrinsic
The intrinsic package provides some intrinsic tasks that convey provides.
----
## convey/clean Task
A clean task will remove files from the host relative and limited to the
directory containing the convey.yml for the run.
### Attributes
| Name | Required | Default | Description |
| --------- | -------- | ------- | ----------- |
| files | Yes | | A list of filenames relative to the convey.yml file to remove. |
### Example
clean:
type: convey/clean
files:
- convey-amd64
- "**/*.pyc"
- "**/__pycache__"
----
## convey/export Task
An export task will move files from the workspace to the host underneath the
directory containing the convey.yml file was found.
### Attributes
| Name | Required | Default | Description |
| --------- | -------- | ------- | ----------- |
| files | Yes | | A single filename or a list of files to copy from the workspace to the host. Files can be specified in one of two forms which can be mixed. The first is `source:destination` and the other is `filename` where filename will be used for both the host and the volume. |
### Examples
export:
type: convey/export
files: filename1
export:
type: convey/export
files:
- logo.png
- binary:binary-linux-x86_64
----
## convey/fail Task
The fail task just automatically fails. It's similar to `convey/noop` in that
it's mostly used for debugging.
### Attributes
None.
### Example
clean:
type: convey/fail
----
## convey/import Task
An import task copies files from the host to the workspace. It has one required
attribute named files. This is a list of files relative to the directory
containing the convey.yml file that will be copied into the workspace.
### Attributes
| Name | Required | Default | Description |
| ----- | -------- | ------- | ----------- |
| files | Yes | | A single filename or a list of files to copy from the host to the workspace. Files can be specified in one of two forms which can be mixed. The first is `source:destination` and the other is `filename` where filename will be used for both the host and the volume. |
### Examples
import:
type: convey/import
files: filename1
import:
type: convey/import
files:
- Dockerfile
- src:source
----
## convey/noop Task
A noop task does nothing. It is a "No Operation" task. It's used primarily in
testing, but could be used for stubbing stuff out or debugging.
### Attributes
None.
### Example
clean:
type: convey/noop