--- a/docs/configuration.md Sun Mar 27 04:29:21 2022 -0500
+++ b/docs/configuration.md Sun Apr 10 03:09:00 2022 -0500
@@ -34,7 +34,7 @@
In the following example, when the `env1` task is run, the `FOO` environment
variable will be set to `baz`, but when the `env2` task is run, the `FOO`
-environment variable will be set to bar+environment variable will be set to `bar` @@ -131,7 +131,7 @@
| environment | | | A list of environment variables to set. The should be specified in a `NAME` or `NAME=VALUE` format. If no value is provided, the value of the variable from the host will be provided if it is available. These environment variables will be applied on top of any that were set at the top-level and the plan level. |
| name | | the index of the stage | A name to give the stage.
| run | No | on-success | When a stage should be run. Possible values are `on-success`, `on-failure`, or `always`. |
-| tasks | Yes | | A list of task names to be run as part during this stage. If running sequentially they are run in the order that they are provided. If you are just specifying a single task, you can just pass use it's name not in a list. |+| tasks | Yes | | A list of task names to be run as part during this stage. If running sequentially they are run in the order that they are provided. If you are just specifying a single task, you can just pass its name as a single value (not as a list). | --- a/docs/convey.md Sun Mar 27 04:29:21 2022 -0500
+++ b/docs/convey.md Sun Apr 10 03:09:00 2022 -0500
@@ -29,8 +29,8 @@
-An export task will move files from the workspace to the host underneath the-directory containing the `convey.yml` file was found.+An export task will move files from the workspace to the host. Files on the host +will be created relative to the `convey.yml` file. @@ -59,8 +59,8 @@
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.+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. --- a/docs/docker.md Sun Mar 27 04:29:21 2022 -0500
+++ b/docs/docker.md Sun Apr 10 03:09:00 2022 -0500
@@ -48,7 +48,7 @@
The functionality of this task has been removed and the task now just fails.
If you have a use case for this task and would like to keep it, please file
-and issue in our issue tracker.+an issue in our issue tracker. @@ -167,13 +167,13 @@
0.15.0. Use the podman/pull task instead.
This task allows you to pull down a container image. If the image is private,
-be use to run a `docker/login` task first.+be sure to run a `docker/login` task first. | Name | Required | Default | Description |
| ------ | -------- | ------- | ----------- |
-| image | | | The name of the image include the tag. |+| image | | | The name of the image including the tag. | | images | | | A list of image names including the tags. |
At least one image must be supplied by either the `image` or `images`
@@ -196,14 +196,14 @@
0.15.0. Use the podman/push task instead.
This task allows you to push a local container image to a registry. If the
-repository on the registry is private, be use to run a `docker/login` task+repository on the registry is private, be sure to run a `docker/login` task | Name | Required | Default | Description |
| ------ | -------- | ------- | ----------- |
-| image | | | The name of the image include the tag. |+| image | | | The name of the image including the tag. | | images | | | A list of image names including the tags. |
At least one image must be supplied by either the `image` or `images`
@@ -234,7 +234,7 @@
| Name | Required | Default | Description |
| ------ | -------- | ------- | ----------- |
-| image | | | The name of the image include the tag. |+| image | | | The name of the image including the tag. | | images | | | A list of image names including the tags. |
| quiet | | false | True if a missing image should not count as a failure. |
@@ -266,12 +266,12 @@
| Name | Required | Default | Description |
| ----------- | -------- | ------- | ----------- |
| command | | | The command to run in the container. This is only necessary if the image does not provide a command by default. |
-| detach | | false | This is deprecated and no longer support. |-| entrypoint | | | The entrypoint to use for the container. This is only necessary if the image does not provide on by default or if you want to override the image's default entrypoint. |+| detach | | false | This is deprecated and no longer supported. | +| entrypoint | | | The entrypoint to use for the container. This is only necessary if the image does not provide one by default or if you want to override the image's default entrypoint. | | environment | | | A list of environment variables to set. This should be specified in a `NAME` or `NAME=VALUE` format. |
-| healthcheck | | | THis is deprecated and no longer support. |+| healthcheck | | | This is deprecated and no longer supported. | | hostname | | | A custom hostname to set inside the container. |
-| image | Yes | | The image include the registry and tag to run. |+| image | Yes | | The image including the registry and tag to run. | | labels | | | A list of labels to set on the image being run. |
| script | | | A list of commands to run inside of the container. |
| shell | | | The shell to use with the script attribute above. |
@@ -289,7 +289,7 @@
-A basic example using a a standard image to do something else.+A basic example using a standard image to do something else. @@ -315,7 +315,7 @@
| Name | Required | Default | Description |
| ----------- | -------- | ------- | ----------- |
| source | Yes | | The full source image including the registry and tag to tag. |
-| destination | Yes | | The destination tag include the registry and tag to create. |+| destination | Yes | | The destination tag including the registry and tag to create. | --- a/docs/examples.md Sun Mar 27 04:29:21 2022 -0500
+++ b/docs/examples.md Sun Apr 10 03:09:00 2022 -0500
@@ -90,7 +90,7 @@
-This example logs into the the registry at the start of the plan and regardless+This example logs into the registry at the start of the plan and regardless of the result of the plan will always logout before exiting. It also will look
for the `REGISTRY_USERNAME` and `REGISTRY_PASSWORD` on the host to keep them
--- a/docs/podman.md Sun Mar 27 04:29:21 2022 -0500
+++ b/docs/podman.md Sun Apr 10 03:09:00 2022 -0500
@@ -76,7 +76,7 @@
This task allows you to pull down a container image. If the image is private,
-be use to run a `podman/login` task first.+be sure to run a `podman/login` task first. @@ -152,10 +152,10 @@
| ----------- | -------- | ------- | ----------- |
| annotations | | | A list of annotations to set on the container being run. |
| command | | | The command to run in the container. This is only necessary if the image does not provide a command by default. |
-| entrypoint | | | The entrypoint to use for the container. This is only necessary if the image does not provide on by default or if you want to override the image's default entrypoint. |+| entrypoint | | | The entrypoint to use for the container. This is only necessary if the image does not provide one by default or if you want to override the image's default entrypoint. | | environment | | | A list of environment variables to set. This should be specified in a `NAME` or `NAME=VALUE` format. |
| hostname | | | A custom hostname to set inside the container. |
-| image | Yes | | The image include the registry and tag to run. |+| image | Yes | | The image including the registry and tag to run. | | script | | | A list of commands to run inside of the container. |
| shell | | | The shell to use with the script attribute above. |
| user | | | The user to run the container as. |
@@ -172,7 +172,7 @@
-A basic example using a a standard image to do something else.+A basic example using a standard image to do something else. @@ -195,7 +195,7 @@
| Name | Required | Default | Description |
| ------- | -------- | ------- | ----------- |
| image | Yes | | The full source image including the registry and tag to tag. |
-| targets | Yes | | The destination tag include the registry and tag to create. |+| targets | Yes | | The destination tag including the registry and tag to create. | --- a/docs/script.md Sun Mar 27 04:29:21 2022 -0500
+++ b/docs/script.md Sun Apr 10 03:09:00 2022 -0500
@@ -33,7 +33,7 @@
-Run an ahhoc script with a single command. The commands parameter will work+Run an adhoc script with a single command. The `commands` parameter will work with a single string or a list of strings
--- a/docs/usage.md Sun Mar 27 04:29:21 2022 -0500
+++ b/docs/usage.md Sun Apr 10 03:09:00 2022 -0500
@@ -1,7 +1,7 @@
Convey is a terminal based application. It has a few subcommands, but it will
-primarily because called with the [run](#run) subcommand.+primarily be called with the [run](#run) subcommand. 